소개
댓글 - 더 간단할 수도 있고 전체 기사를 작성하는 이유도 있을 것 같습니다. 그러나 그렇게 간단하지는 않습니다. 상사가 말했듯이 코드는 누구나 작성할 수 있지만 좋은 댓글을 작성하는 것은 어렵습니다. 대부분의 언어 코스는 전통적인 Hello World로 시작됩니다. Oracle Tutorials 의 "시작하기" 섹션에서도 "Hello World!" 로 시작합니다. 애플리케이션 . 그리고 코드의 첫 번째 줄부터 Java 주석을 볼 수 있습니다. Java Code Convention과 같은 중요한 문서에서 주석이 별도의 섹션인 Comments 로 제공된다는 사실에서도 그 중요성이 강조됩니다 . 문서에 따르면 Java의 주석은 두 가지 유형으로 나뉩니다.- 구현 주석(또는 코드 주석)
- 코멘트를 문서화하고 있습니다.
자바 코드 주석
이름을 보면 이 주석이 코드와 관련되어 있으며 코드의 기능을 반영해야 한다는 것이 분명합니다. 코드 주석은 다음과 같습니다.-
소문자(즉, 한 줄로 설명)
// Строчный комментарий System.out.println("Hello, World!");
-
블록(즉, 한 줄에 맞지 않기 때문에 전체 블록으로 설명됩니다)
/* * Блочный комментарий */ System.out.println("Hello");
댓글을 쓸 때마다 움츠러들고 실패한 것 같은 기분이 든다"고 말했다.절대적인 진실은 없다는 것이 분명하며 때로는 의견이 필요합니다. 하지만 언제나 선택의 여지가 있으며, 불필요한 댓글은 맞서 싸워야 합니다. 이 장에서는 또한 특이한 주석 TODO에 대해 언급합니다.
// TODO: Добавить World
System.out.println("Hello, ");
요점은 IDE에서 특별한 방법으로 처리할 수 있다는 것입니다. 예를 들어 IDEA에서는 별도의 탭에 수집되어 볼 수 있습니다.
문서에 대한 설명
문서 주석은 공개 API를 설명합니다. API 는 애플리케이션 프로그래밍 인터페이스, 즉 다른 개발자가 작업을 수행하는 데 사용할 수 있는 클래스와 메서드입니다. 간단히 말해서, 이러한 주석은 왜 이 클래스와 패키지가 생성되었는지, 그리고 이 메서드나 저 메서드가 수행하는 작업을 설명해야 합니다. 필요한 경우 클래스 필드를 설명할 수도 있습니다. 이것이 바로 JavaDoc 형식의 IDE 툴팁에서 볼 수 있는 내용입니다. 예를 들어:package test;
/**
* This is a JavaDoc class comment
*/
public class JavaDocTest {
/**
* This is a JavaDoc public field comment
*/
public static final String HELLO_MESSAGE = "Hello, World!";
public static void main(String... args) {
JavaDocTest.greetings();
}
/**
* This is a JavaDoc public method comment
*/
public static void greetings() {
System.out.println(HELLO_MESSAGE);
}
}
그런 다음 패키지 디렉터리가 포함된 디렉터리에서 다음 명령을 실행할 수 있습니다. javadoc -d ./test test
그런 다음 문서 생성 프로세스를 볼 수 있습니다.
GO TO FULL VERSION