[java] 주석 작성 규칙

12 Dec 2023

java

자바 코드에서 주석은 코드의 가독성을 높이고 유지 보수를 용이하게 만듭니다. 다양한 주석 유형과 작성 규칙에 대해 알아봅시다.

1. 블록 주석

/*
 * 이 블록 주석은 여러 줄의 설명을 포함할 수 있습니다.
 * 보통 클래스나 메소드 위에 작성하며 일반적으로 Javadoc 형식을 따릅니다.
 */
public class MyClass {
    // 클래스의 내용
}

2. 라인 주석

// 이 라인 주석은 한 줄 설명에 사용됩니다.
public void myMethod() {
    // 메소드의 내용
}

3. 문서화 주석 (Javadoc)

/**
 * 이 문서화 주석은 Javadoc을 생성하는 데 사용됩니다.
 * 클래스, 메소드, 필드 등의 설명을 포함하며 HTML 태그를 사용할 수 있습니다.
 *
 * @param paramName 파라미터에 대한 설명
 * @return 반환 값에 대한 설명
 */
public void myMethod(int paramName) {
    // 메소드의 내용
}

4. 중요한 주석

// TODO: 나중에 수정해야 할 부분에 대한 주석
// FIXME: 버그나 오류 수정이 필요한 부분에 대한 주석

주석은 코드의 이해를 돕고 개발 과정을 지원하기 위해 적절히 활용되어야 합니다. 주석을 작성할 때는 다른 개발자가 이해하기 쉽도록 명확하고 간결하게 작성하는 것이 중요합니다.

자세한 내용은 Oracle Java SE Documentation를 참고하시기 바랍니다.