Java 코드 주석 사양에 대한 자세한 설명(파워 노드 구성)

코드댓글은 프로그램 디자이너와 프로그램 독자 사이의 소통 다리 역할을 하여 팀 개발 협력의 효율성을 극대화합니다. 이는 또한 프로그램 코드 유지 관리의 중요한 측면 중 하나입니다. 이번 글을 통해 우리가 일상적인 개발에서 사용하는 코드 주석 사양에 대해 이야기해보겠습니다

코드 주석은 프로그램 디자이너와 프로그램 독자 사이의 의사소통 다리 역할을 하며 팀 개발 협력의 효율성을 극대화합니다. 이는 또한 프로그램 코드 유지 관리의 중요한 측면 중 하나입니다. 그래서 우리는 댓글을 쓰기 위해 댓글을 쓰지 않습니다. 참고를 위해 일상적인 개발에서 사용하는 코드 주석 사양에 대해 이야기해 보겠습니다.

1. 통일된 댓글 양식

애플리케이션 전반에 걸쳐 일관된 구두점과 구조를 갖춘 스타일을 사용하여 댓글을 구성합니다. 다른 프로젝트에서 해당 주석 사양이 이 문서와 다르다는 것을 발견하면 이 사양에 따라 코드를 작성하고 기존 사양 시스템에 새로운 사양을 도입하려고 시도하지 마세요.

2. 주석 내용은 정확하고 간결해야 합니다.

내용은 간결하고 명확하며 의미가 정확해야 합니다. 잘못된 주석은 도움이 되지 않을 뿐만 아니라 해롭습니다.

주석 조건:

1. 기본 주석

(a) 클래스(인터페이스) 주석

(b) 생성자 주석

(c) 메서드 주석

(d) 전역설명 변수

(e) 필드/속성

에 대한 설명 참고: 심플코드에 대해서는 간단한 설명을 작성하고, 설명 내용은 10단어를 넘지 않아야 합니다. 또한 영구 객체 또는 VO 객체의 getter 및 setter 메서드에는 주석을 달 필요가 없습니다. 구체적인 설명 형식은 아래 예를 참조하세요.

2. 특별한 코멘트가 필요합니다.

(a) 일반적인 알고리즘에는 코멘트가 있어야 합니다.

(b) 코드가 불명확한 댓글이 있어야 합니다.

(c) 코드 수정에 수정 내용을 나타내는 주석을 추가합니다.

(d) 루프와 논리 분기로 구성된 코드에 주석을 추가합니다.

(e) 타인에게 제공되는 인터페이스에 대해서는 자세히 설명해야 합니다.

참고: 이러한 유형의 댓글 형식에 대한 예는 아직 없습니다. 구체적인 주석 형식은 직접 정의하며, 주석 내용은 정확하고 간결해야 합니다.

댓글 형식:

1. 한 줄 댓글: "//……"

2. 차단 댓글: “/**/”

3. 문서 댓글: “/***/”

4. Javadoc 댓글 태그 구문

@author 클래스 설명은 이 유형의 모듈을 개발한 작성자를 나타냅니다.
@version 클래스 설명은 이 유형의 모듈 버전을 나타냅니다.
@see 클래스, 속성 및 메소드에 대한 설명 즉, 관련 주제를 의미합니다.
@param 메소드 설명
@return 메소드의 특정 매개변수에 대한 설명 메소드의 반환 값에 대한 설명입니다.
@예외 메서드 설명 메서드에서 발생할 수 있는 예외를 설명합니다.

참조 예:

1. 클래스(인터페이스) 코멘트

예:

/**
* 类的描述
* @author Administrator
* @Time 2016-11-14:49:01
*
*/
public classTest extends Button {
 ……
}

2. 메소드 코멘트 예:

public class Test extends Button {
 /**
 * 构造方法 的描述
 * @param name
 * 按钮的上显示的文字
 */
 public Test(String name){
 ……
 }
}

4. 전역 변수 주석

예:

public class Test extends Button {
 /**
 * 为按钮添加颜色
 *@param color
  按钮的颜色
*@return
*@exception (方法有异常的话加)
* @author Administrator
* @Time2012-11-20 15:02:29
 */
 public voidaddColor(String color){
 ……
 }
}

5.

예: rree

사실 스펙은 스스로 정하는 거지만 팀원 모두가 준수하고 통일하면 좋은 효과가 있길 바라요. 평소에 댓글을 달지 않는 친구들에게 도움이 될 것입니다.

위 내용은 Java 코드 주석 사양에 대한 자세한 설명(파워 노드 구성)의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!