주석 스타일

1. 개요

//또는/* */일반적으로 모두 사용되며 통일만 하면 됩니다.

해명

//또는/* */모두 가능하지만//가 더 많이 사용되기 때문에 치수 및 주석 스타일 방법에 대한 균일성을 보장해야 합니다.

문서 주석

1. 개요

저작권, 작성자, 시간 등에 대한 설명을 추가합니다. 각 파일의 시작 부분에 있습니다. 파일 주석은 파일의 내용을 설명합니다. 파일이 하나의 객체만 선언, 구현 또는 테스트하고 객체가 선언될 때 이미 상세하게 주석을 단 경우 파일 주석을 추가할 필요가 없으며 다른 모든 파일에는 파일 주석이 필요합니다.

해명

법적 고지 사항 및 저자 정보:

각 파일은 라이센스 참조를 포함해야 하며 프로젝트에 적합한 라이센스 버전 (예: Apache 2.0, BSD, LGPL, GPL) 을 선택해야 합니다.

원본 작성자 파일을 크게 수정한 경우 원본 작성자 정보를 삭제하는 것이 좋습니다.

함수 주석

1. 개요

함수 선언의 주석은 함수를 설명합니다. 정의의 주석은 함수 구현을 설명합니다.

해명

함수 선언:

기본적으로 각 함수 선언 앞에는 함수의 역할과 용도를 설명하는 주석이 있어야 하며, 간단한 값 및 값 설정 함수와 같이 함수가 단순하고 명백한 경우에만 이러한 주석을 생략할 수 있습니다. 함수 정의:

함수가 교묘하게 구현된 경우 함수 정의에 주석을 추가해야 합니다. 예를 들어, 사용하는 프로그래밍 기술, 구현의 일반적인 단계 또는 구현 이유를 설명하십시오. 예를 들어 함수의 전반부가 잠겨 있고 후반부가 필요하지 않은 이유를 설명할 수 있습니다.

변수 주석

1. 개요

경우에 따라 변수 이름 자체는 일반적으로 변수의 용도를 설명하기에 충분하며 추가 주석이 필요합니다.

해명

장면과 수정자에 따라 변수를 여러 범주로 나눌 수 있습니다. 일반적으로 변수는 전역 변수와 로컬 변수로 나눌 수 있습니다. 일반적으로 로컬 변수는 로컬 범위로 제한되며 의미는 비교적 간단하고 이해하기 쉬우며 간단한 주석만 있으면 됩니다. 글로벌 변수는 일반적으로 여러 파일이나 전체 프로젝트에 적용되므로 의미가 비교적 복잡하므로 주석을 달 때 구체적인 의미를 명확하게 설명하는 것이 좋습니다. 즉, 가능한 한 포괄적으로 설명하는 것이 좋습니다.

병음 주석

1. 개요

하나의 변수나 함수에는 여러 단어로 철자를 써야 하는 매우 복잡한 의미가 포함될 수 있으므로 철자에 대한 자세한 주석이 필요합니다.

해명

주석은 보통 정확한 대문자와 끝 마침표를 가진 완전한 서술적 문장으로 쓰여진다. 대부분의 경우, 완전한 문장은 문장 조각보다 더 가독성이 있다. 코드 행의 끝에 있는 주석과 같은 짧은 주석은 임의적일 수 있지만 스타일의 일관성에 유의해야 합니다. 또한 주석에서 철자와 쉼표도 중요합니다. 다른 사람이 세미콜론을 사용해야 한다고 지적할 때 쉼표를 사용하는 것은 어색하지만 명확하고 읽기 쉬운 코드는 중요하며 정확한 문장 부호, 맞춤법, 문법이 도움이 될 수 있다. (데이비드 아셀, Northern Exposure (미국 TV 드라마), 언어명언)

TODO 주석

1. 개요

임시, 단기 솔루션, 또는 충분하지만 여전히 불완전한 코드의 경우 TODO 주석을 사용합니다.

TODO 주석은 모두 대문자인 문자열 TODO 를 사용해야 하며 이름, 이메일 주소, 버그 id 또는 기타 id 및 이 TODO 와 관련된 문제를 괄호 안에 적어야 합니다. 주요 목적은 의견을 추가한 사람이 (자세한 내용을 요청할 수 있음) 표준 TODO 형식을 기준으로 검색할 수 있도록 하는 것입니다. TODO 주석을 추가하는 것은 스스로 수정해야 한다는 것을 의미하지 않기 때문에 이름이 있는 TODO 를 추가할 때 보통 자신의 이름을 쓴다.