2008/11/28 16:09
Voice Portal/Dialog Designer
javadoc을 많이 들어봤지만 뭔지 모르고 그냥 지냈었다.
그런데 프로젝트를 개발하면 소스에 대한 문서를 만들 때가 있는데 이때 이것을 이용한다면 굉장히 편할 것 같다는 생각에 검색을 해봤다.
간단히 javadoc.exe를 이용하여 생성된 결과물을 보자.
어디서 많이 본듯한 그것???
아래 결과물은 VRUSM test작업을 하기 위해서 개발된 test application이다.
물론 코드생성기에 의해서 작성된 주석들이 내용으로 들어가 있기 때문에 영어이지만,
코드 생성기의 내용은 대부분의 동일하기 때문에 이 부분만 수정을 한다면 유용할 것으로 보인다.
아래 내용을 보면은 Packages와 All classes가 나와있다.
즉 application상에 사용된 모든 것들을 포함하고 있다고 봐도 좋다. 아니 그렇다.
또 코드 생성기에 의해 작성된 내용뿐만아니라 javadoc을 만들기 위한 주석 사용법만 안다면 나중에 일일이 코드를 열어가면서 문서를 작성하는 것이 아니라 javadoc으로 만든 html페이지들을 클릭하면서 빠르게 문서화 작업을 할 수 있을 것 같다.
javadoc 생성하는 법은 인터넷 검색을 하면 쉽게 할 수 있을 것이다.
그런데 프로젝트를 개발하면 소스에 대한 문서를 만들 때가 있는데 이때 이것을 이용한다면 굉장히 편할 것 같다는 생각에 검색을 해봤다.
간단히 javadoc.exe를 이용하여 생성된 결과물을 보자.
어디서 많이 본듯한 그것???
아래 결과물은 VRUSM test작업을 하기 위해서 개발된 test application이다.
물론 코드생성기에 의해서 작성된 주석들이 내용으로 들어가 있기 때문에 영어이지만,
코드 생성기의 내용은 대부분의 동일하기 때문에 이 부분만 수정을 한다면 유용할 것으로 보인다.
아래 내용을 보면은 Packages와 All classes가 나와있다.
즉 application상에 사용된 모든 것들을 포함하고 있다고 봐도 좋다. 아니 그렇다.
또 코드 생성기에 의해 작성된 내용뿐만아니라 javadoc을 만들기 위한 주석 사용법만 안다면 나중에 일일이 코드를 열어가면서 문서를 작성하는 것이 아니라 javadoc으로 만든 html페이지들을 클릭하면서 빠르게 문서화 작업을 할 수 있을 것 같다.
javadoc 생성하는 법은 인터넷 검색을 하면 쉽게 할 수 있을 것이다.
'Voice Portal > Dialog Designer' 카테고리의 다른 글
| How can XML be used? (0) | 2009/01/09 |
|---|---|
| vxml+ccxml can make a call. (0) | 2008/12/03 |
| [java] Javadoc 사용 (0) | 2008/11/28 |
| [log4j]DailyRollingFileAppender의 DatePattern 옵션 (0) | 2008/11/28 |
| /conf/Catalina/localhost의 xml파일 (0) | 2008/11/26 |
| [xml]XML 파일 읽어오기 (0) | 2008/11/24 |
