패키지 레벨 Javadoc 주석을 작성하려고 할 때 선호되는 방법은 무엇입니까? 너 뭐하니?
package-info.java
- 찬성
- 최신
- 단점
- 수업의 남용-수업은 댓글 용이 아닌 코드 용입니다.
package.html
- 찬성
- HTML 확장은 코드가 아님을 의미합니다.
- IDE / 텍스트 편집기에서 구문 강조
- 단점
- 없어요?
필자는 항상 Package.html을 사용했습니다. 그러나 올바른 선택인지 궁금합니다.
답변
package-info.java: “이 파일은 JDK 5.0의 새로운 파일이며 package.html보다 선호됩니다.”— javadoc-Java API 문서 생성기
부록 : 큰 차이점은 패키지 주석 인 것 같습니다 . 7.4 패키지 선언 에는 이론적 근거가 조금 더 있습니다.
부록 : 주석 기능은 여기 및 여기 에서도 언급 됩니다 .
부록 참조 : 무엇 package-info.java을 위해? .
