Java 프로그램은 구현 주석과 문서화 주석의 두 가지 주석을 가질 수 있습니다. 구현 주석은 /*...*/ 및 //로 구분되는 C++에서 볼 수 있는 주석입니다. 문서화 주석(“문서 주석”이라고 함)은 Java 전용이며 /**...*/로 구분됩니다. 문서 주석은 javadoc 도구를 사용하여 HTML 파일로 추출할 수 있습니다.

구현 주석은 코드를 주석 처리하거나 특정 구현에 대한 주석을 위한 것입니다. 문서 주석은 구현이 필요 없는 관점에서 코드의 명세를 설명하는 것으로 소스 코드가 없을 수도 있는 개발자가 읽도록 의도된 것입니다.

코드의 개요를 제공하고 코드 자체에서 쉽게 사용할 수 없는 추가 정보를 제공하기 위해 주석을 사용해야 합니다. 주석에는 프로그램을 읽고 이해하는 데 관련된 정보만 포함되어야 합니다. 예를 들어, 해당 패키지의 빌드 방법 또는 패키지가 위치한 디렉토리에 대한 정보는 주석으로 포함되어서는 안 됩니다.

사소하지 않거나 명백하지 않은 디자인 결정에 대한 논의는 적절하지만, 코드에 존재하며 명확한 정보는 중복하지 마십시오. 중복된 주석은 너무 쉽게 구식이 됩니다. 일반적으로 코드가 발전함에 따라 구식이 될 가능성이 있는 주석은 피하십시오.

Note: 주석의 빈도는 때때로 코드의 품질이 좋지 않음을 반영합니다. 주석을 더 추가해야 겠다고 느낄때, 코드를 재작성하여 더 명확하게 하는 것을 고려하세요

별표(*)나 다른 문자로 그려진 큰 박스에 주석을 넣으면 안 됩니다.
주석에는 양식 피드 및 백스페이스와 같은 특수 문자가 포함되어서는 안 됩니다.

프로그램은 블록, 한 줄, 후행 및 줄 끝의 네 가지 스타일의 구현 주석을 가질 수 있습니다.

Code Conventions for the Java Language 5 - Comments