프로그램 개발자가 코드에 댓글을 첨부하는 것이 매우 중요합니다. 기술 개발을 통해 프로그래머는 프로젝트 개발 중에 코드 댓글을 작성해야하며, 이는 코드의 후속 쓰기 및 사용에 도움이됩니다.
기본 요구 사항 :
1. 통합 주석 양식
응용 프로그램 전체에서 일관된 구두점 및 구조가있는 스타일을 사용하여 주석을 구성하십시오. 주석 사양이 다른 프로젝트 에서이 문서와 다른 경우이 사양에 따라 코드를 작성하고 설정된 사양 시스템에 새로운 사양을 도입하려고 시도하지 마십시오.
2. 주석 내용은 정확하고 간결합니다
내용은 간단하고 명확하며 정확해야하며, 의미는 주석의 모호함에서 방지해야합니다. 잘못된 의견은 쓸모가 없을뿐만 아니라 유해합니다.
3. 기본 주석 (추가되어야 함)
(a) 수업에 대한 의견 (인터페이스)
(b) 생성자의 논평
(c) 방법에 대한 의견
(d) 글로벌 변수의 의견
(e) 필드/속성에 대한 메모 : 간단한 코드는 간단한 주석을 만듭니다. 주석 내용은 10 단어를 넘지 않으며, 또한 개체 또는 지속적인 개체 또는
VO 객체의 getter 및 setter 메소드에 댓글을 달 필요가 없습니다. 특정 주석 형식은 다음 예제를 참조하십시오.
4. 특별 주석이 추가되어야합니다 (추가해야합니다)
(a) 일반적인 알고리즘에 주석해야합니다.
(b) 의견은 불분명 한 코드로 작성해야합니다.
(c) 코드 수정에서 수정 마크에 주석을 추가하십시오.
(d) 루프 및 논리 분기로 구성된 코드의 의견.
(e) 다른 사람에게 제공된 인터페이스에 자세히 설명해야합니다.
참고 :이 유형의 주석 형식에는 예제가 없습니다. 특정 주석 형식은 스스로 정의되며 주석 내용은 정확하고 간결해야합니다.
5. 댓글 형식 :
1) 단일 라인 코멘트 : "// ..."
2) 블록 코멘트 : "/*…*/"
3) 문서 설명 : "/**…*/"
4) Javadoc 주석 태그 구문
@Author 클래스의 설명은 클래스 모듈을 개발 한 저자를 나타냅니다.
@version 클래스의 설명은 클래스 모듈의 버전을 나타냅니다.
@참조 참조 클래스, 속성 및 방법, 즉 관련 주제에 대한 설명으로 전환
메소드의 메소드 설명에 대한 @Param 설명
메소드 리턴 값의 메소드 설명에 대한 @return 설명
@Exception 메소드 설명에 대한 설명에 대한 설명이 방법에 의해 던질 수있는 예외 설명
6. 예 :
/** 어레이를 조작하기위한 공구 클래스를 만듭니다. 여기에는 작동 배열을위한이 공통 기능이 포함되어 있습니다. @author zhang san @버전 v. */ public class arraytool {/ ** gray @param arr @param array의 최대 값을 얻습니다 @return 배열의 최대 요소 값 */ public int getmax (int max =; 리턴 맥스; }}아래 그림과 같이 명령을 입력하십시오.
그런 다음 다음 디렉토리에서 확인하고 최종적으로 index.html을 클릭하십시오.
위의 내용은 Java Code Comment Specations와 귀하에게 도움이되기를 바라고 있습니다.