구글 스타일 가이드

1 개요[ | ]

Google Style Guides
구글 스타일 가이드

모든 주요 오픈 소스 프로젝트에는 고유한 스타일 가이드가 있다. 즉, 해당 프로젝트의 코드를 작성하는 방법에 대한 일련의 규칙(때로는 임의적)이다. 큰 코드베이스에 있는 모든 코드가 일관된 스타일일 때 훨씬 더 쉽게 이해할 수 있다.

"스타일"은 "변수 이름에 camelCase 사용"에서 "전역 변수 사용 금지", "절대 예외 사용"에 이르기까지 많은 근거를 다룬다. 이 프로젝트(google/styleguide)는 Google 코드에 사용하는 스타일 가이드라인으로 연결된다. Google에서 시작된 프로젝트를 수정하는 경우 이 페이지로 이동하여 해당 프로젝트에 적용되는 스타일 가이드를 볼 수 있다.

이 프로젝트에는 다음과 같은 스타일 가이드가 있다.

본 프로젝트에도 스타일 가이드 준수를 지원하는 도구 cpplint와, Google 스타일용 Emacs 설정 파일인 google-c-style.el를 포함되어 있다.

프로젝트에서 새 XML 문서 형식을 만들어야 하는 경우 XML 문서 형식 스타일 가이드가 도움이 될 수 있다. 실제 스타일 규칙 외에도 고유한 디자인과 기존 형식 조정, XML 인스턴스 문서 형식, 요소 대 속성(elements vs. attributes.)에 대한 조언도 포함되어 있다.

이 프로젝트의 스타일 가이드는 CC-By 3.0 라이선스를 따르므로, 문서를 공유할 수 있다. 자세한 내용은 https://creativecommons.org/licenses/by/3.0/ 을 참조하자.

다음과 같은 구글 스타일 가이드들은 이 프로젝트의 외부에 있다: Effective Dart

2 기여[ | ]

몇 가지 예외를 제외하고 이 스타일 가이드는 Google이 소유하고 생성한 오픈소스 프로젝트에서 작업하는 개발자를 지원하기 위한 Google 내부 스타일 가이드의 사본이다. 스타일 가이드에 대한 변경사항은 먼저 내부 스타일 가이드에 적용되고, 결국에는 여기에 있는 버전으로 복사된다. 외부 기여는 허용되지 않는다. 풀 리퀘스트는 코멘트 없이 정기적으로 마감된다. 질문을 제기하거나, 기술적 장점에 대한 변경을 정당화하거나, 명백한 실수를 지적하는 문제는 참여를 유도할 수 있으며 이론적으로 변경으로 이어질 수 있지만, 대체로는 Google의 내부 요구에 맞게 최적화되고 있다.

3 참고[ | ]