javadoc과 package.html
- Development/Java
- 2009. 8. 5.
작성한 자바코드를 표준 doclet의 javadoc으로 돌리면,
package의 설명이 휑허니 빈칸으로 나온다.
어떻게 주석을 달면, package에 대한 설명을 넣을 수 있을까?
package의 entry에 package.html을 작성해 주면 이 문제가 해결된다.
만약 package ab.cd.ef.* 가 존재한다면,
디렉토리가 ab/cd/ef가 존재할 것이다.
따라서, ab/cd/ef/pacakge.html을 작성해주면 javadoc 실행시
package의 description을 채워준다.
이 때, 작성 형식은 매우 간단하다. 다음과 같이 기록하기만 하면
body 부분의 설명이 그대로 반영된다.
package의 설명이 휑허니 빈칸으로 나온다.
어떻게 주석을 달면, package에 대한 설명을 넣을 수 있을까?
package의 entry에 package.html을 작성해 주면 이 문제가 해결된다.
만약 package ab.cd.ef.* 가 존재한다면,
디렉토리가 ab/cd/ef가 존재할 것이다.
따라서, ab/cd/ef/pacakge.html을 작성해주면 javadoc 실행시
package의 description을 채워준다.
이 때, 작성 형식은 매우 간단하다. 다음과 같이 기록하기만 하면
body 부분의 설명이 그대로 반영된다.
<html>
<head>
<body>
넣고 싶은 설명 기록
</body>
</head>
</html>
<head>
<body>
넣고 싶은 설명 기록
</body>
</head>
</html>
'Development > Java' 카테고리의 다른 글
| war 배포시 root context로 하려면? (0) | 2012.01.02 |
|---|---|
| JUnit에서의 예외 인식 (0) | 2010.08.04 |
| JUnit으로 test coverage를 높이는 습관 (0) | 2010.08.02 |
| Eclipse의 hashCode+equals VS. Apache의 HashCodeBuilder+EqualsBuilder (0) | 2010.06.21 |
| FindBugs - EQ_COMPARETO_USE_OBJECT_EQUALS 해결 (0) | 2010.06.21 |
| [Spring] MultiActionController에서 Validator 쓰기 (0) | 2009.09.01 |
| Eclipse에서 java 소스로부터 클래스 다이어그램을 쉽게 만들자/ eUML2 (0) | 2009.08.06 |
| Eclipse에서 javadoc을 pdf로 출력하기 (0) | 2009.08.05 |