반응형
Java에서 패키지를 문서화하는 방법
Java API에서 패키지에 대한 Javadoc 코멘트를 볼 수 있습니다.
패키지를 문서화하기 위해 Javadoc 코멘트를 어디에 배치해야 합니까?
1.5 이후로는package-info.java패키지에 대한 표준 javadoc 스타일의 코멘트를 제공합니다.
com/foo/foo-info.syslog:
/**
* com.foo is a group of bar utils for operating on foo things.
*/
package com.foo;
//rest of the file is empty
Java 1.4까지 기타 답변에서 설명한 바와 같이 HTML 파일 package.html을 제공해야 했습니다.
Java 1.5를 사용하면package-info.java표준 Javadoc 코멘트가 포함되어 있습니다(HTML 없음).후자는 몇 가지 추가 기능(특히 패키지 주석)을 제공하므로 권장됩니다.
세부사항:javadoc용 Sun 문서
를 사용하여package.html패키지 레벨의 파일(즉, 그 패키지의 디렉토리에 있습니다).이것은 완전한 형식이어야 합니다.HTML파일, 를 사용하여<html>정의된 태그
언급URL : https://stackoverflow.com/questions/624422/how-do-i-document-packages-in-java
반응형
'programing' 카테고리의 다른 글
| 0과 1 사이의 랜덤 부동 생성 (0) | 2022.08.14 |
|---|---|
| 라우터 뷰에서 외부 컴포넌트로의 Vuej (0) | 2022.08.14 |
| Vue-Router의 내비게이션가드에서 뒤로 버튼 검출 (0) | 2022.08.14 |
| 함수 포인터의 포인트는 무엇입니까? (0) | 2022.08.14 |
| 왜 '?'와 '\?'는 C에서 같은 출력을 출력합니까? (0) | 2022.08.14 |