Java 코드 주석 사양(동력 노드 정리)

코드 주석은 프로그래머와 프로그래머 간의 통신 다리를 놓아 팀 개발 협력 효율을 최대한 높인다.프로그램 코드의 유지보수성의 중요한 부분 중 하나이기도 하다.그래서 우리는 주석을 쓰기 위해 주석을 쓰는 것이 아니다.다음은 우리가 일상 개발에서 사용하는 코드 주석 규범을 참고하도록 하겠습니다.
1. 주석 형식 통일
전체 응용 프로그램에서 일관된 문장부호와 구조를 가진 스타일을 사용하여 주석을 구성합니다.만약 다른 항목에서 그들의 주석 규범이 이 문서와 다르다는 것을 발견한다면, 이 규범에 따라 코드를 쓰고, 기존의 규범 시스템에 새로운 규범을 도입하려고 하지 마라.
2. 주석 내용이 정확하고 간결하다
내용은 간단하고 명확하며 의미가 정확해야 하며 주석의 다의성을 방지해야 한다. 잘못된 주석은 무익할 뿐만 아니라 오히려 해롭다.
주석 기준:
1. 기본 주석
(a) 클래스(인터페이스)에 대한 설명
(b) 구조 함수의 주석
(c) 방법에 대한 설명
(d) 전역 변수에 대한 설명
(e) 필드/속성에 대한 주석
비고: 간단한 코드로 간단한 주석을 하고 주석 내용이 10글자 이상이면 됩니다. 또한 지속화 대상이나 VO 대상의 getter,setter 방법은 주석을 달지 않아도 됩니다.구체적인 주석 형식은 아래의 예를 참고하십시오.
2. 특수 추가 설명
(a) 전형적인 알고리즘은 반드시 주석이 있어야 한다.
(b) 코드가 명확하지 않은 곳에는 반드시 주석이 있어야 한다.
(c) 코드 수정처에 표지를 수정하는 주석을 추가합니다.
(d) 순환과 논리 분기로 구성된 코드에 주석을 추가합니다.
(e) 다른 사람에게 제공된 인터페이스는 상세한 설명을 넣어야 합니다.
비고: 이러한 주석 형식은 예가 없습니다.구체적인 주석 형식은 스스로 정의하고 주석 내용이 정확하고 간결해야 한다.
주석 형식:
1행(single-line) 주석: "//..."
2. 블록(block) 설명: "/*...*/"
3. 문서 주석: "/**...*/"
4.javadoc 주석 라벨 문법
@author 클래스에 대한 설명은 이 모듈을 개발한 저자를 표시합니다
@version 클래스에 대한 설명은 이 모듈의 버전을 표시합니다
@see 클래스, 속성, 방법에 대한 설명 참고 방향, 즉 관련 주제
@param 방법에 대한 설명 방법 중의 매개 변수에 대한 설명
@return 방법에 대한 설명 방법 반환 값에 대한 설명
@exception 방법에 대한 설명 방법이 던질 수 있는 이상에 대한 설명
참조 예:
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){
 ……
 }
}

3. 메소드 주석
예:

public class Test extends Button {
 /**
 *  
 *@param color
   
*@return
*@exception ( )
* @author Administrator
* @Time2012-11-20 15:02:29
 */
 public voidaddColor(String color){
 ……
 }
}

4. 글로벌 변수 주석
예:

public final class String
 implements Java.io.Serializable, Comparable<String>,CharSequence
{
 /** The value is used for characterstorage. */
 private final char value[];
 /** The offset is the first index of thestorage that is used. */
 private final int offset;
 /** The count is the number of charactersin the String. */
 private final int count;
 /** Cache the hash code for the string */
private int hash; // Default to 0
……
}

5. 필드/속성 주석
예:

public class EmailBody implements Serializable{
 private String id;
 private String senderName;// 
 private String title;// 120 
 private String content;// 
 private String attach;// ， 
 private String totalCount;// 
 private String successCount;// 
 private Integer isDelete;//0  1 
 private Date createTime;//   
 privateSet<EmailList> EmailList;
……
}

사실 규범은 스스로 정한 것이다. 팀에서 모두가 통일적으로 준수하고 규범을 통일하면 좋은 효과를 거둘 수 있기 때문에 평소에 주석을 달지 않는 친구에게 도움이 되기를 바란다.
위에서 말한 것은 여러분이 소개한 자바 코드 주석 규범(동력 노드 정리)입니다. 여러분께 도움이 되었으면 합니다. 만약에 궁금한 것이 있으면 저에게 메시지를 남겨 주십시오. 편집자는 제때에 여러분에게 회답할 것입니다.여기에서도 저희 사이트에 대한 지지에 감사드립니다!