주석은 코드를 더 읽기 쉽고, 유지보수하기 쉽게 할 수 있는 가장 기본적인 요소 중 하나입니다.
특히 팀단위로 개발하거나, 오랫동안 유지보수해야 하는 경우 진가를 발휘합니다.
이 글에서는 주석을 좀 더 효과적으로 달고, 내용을 문서화하는 방법을 소개합니다.
XMLDoc과 JavaDoc 주석의 특징과 추가 방법, 문서화 하는 방법을 알아봅니다.
XMLDoc과 JavaDoc 주석 추가
XMLDoc 주석
XMLDoc 주석의 특징
- 3 중 슬래시(///)로 시작
- XML 태그로 작성
- 코드 에디터의 헬프 인사이트에 표시
- XML 태그로 가독성이 다소 떨어짐
XML 주요 항목
- <summary> 함수 또는 클래스에 대한 설명
- <param name="파라메터 이름"> 파라메터에 대한 설명
- <returns> 함수의 반환 값 설명
- < exception cref="예외 유형"> 메소드에서 전달되는 예외
예시
XMLDoc의 특징
XML Doc 주석 추가 시 코드 에디터의 헬프 인사이트에 표시됩니다.
단, 선언부(interface 영역)에 XML Doc 추가 시에만 표시됩니다.
한가지 팁으로, 코드 템플릿에 템플릿을 추가하면 필요시 코드에디터에 주석을 쉽게 추가 할 수 있습니다.
(Ctrl + J > 키워드 입력 또는 키워드 입력 > Ctrl + J)
코드 템플릿 추가방법
View > Tool Windows > Templates 메뉴 선택
New Code Template 버튼 클릭
아래 코드 참고해 XML 태그 수정 후 저장(예> xmldoc.summary.xml)
또는 위 XML 태그로 xml 파일 생성(별도의 텍스트 에디터에서) 및 저장
템플릿 디렉토리에 xml 파일 복사
(10.3 기준 템플릿 디렉토리 : C:\Program Files (x86)\Embarcadero\Studio\20.0\ObjRepos\en\Code_Templates\Delphi)
JavaDoc 주석
자바의 주석 형식으로 주석을 작성하면, 별도 프로그램을 이용 문서화(HTML, CHM, PDF 등)가 가능합니다.
JavaDoc 주석의 특징
- 블록 주성({** 시작 *}로 끝) 또는 한줄 주석(3 중 슬래시(///)로 시작)
- 주석의 속성(태그)은 @으로 시작
- XMLDoc에 비해 주석 가독성이 높음(짧음)
JavaDoc 주요 태그
- 태그 없는 경우 함수에 대한 설명
- @author 작성자
- @version 버전
- @param 메소드 파라메터 설명
- @return 반환 값 설명
- @throws 메소드에서 전달되는 예외
예시
주석 문서화
추가한 주석을 문서화(문서로 내보내기)하는 방법을 알아봅니다.
XMLDoc 주석 문서화
XMLDoc을 문서화 하기 위해서는 Model을 생성해야 합니다.
Projects 팬에서 Model View 탭을 선택 후 모델을 생성합니다.
Model View에서 문서화할 대상(프로젝트 또는 유닛) 선택 후 팝업메뉴에서 "Generate Documentation..." 메뉴를 선택 합니다.
문서화 범위(Scope) 및 옵션(Options)를 선택 후 [OK] 버튼을 클릭 합니다.
결과 예시
다음과 같이 XMLDoc 주석을 추가했습니다.
생성된 HTML은 다음과 같습니다.
JavaDoc 주석 문서화
JavaDoc 포맷의 주석을 문서화 하기 위해서는 별도의 프로그램을 이용해야 합니다.
이 글에서는 DelphiCodeToDoc를 이용해 문서화합니다.
DelphiCodeToDoc은 델파이로 제작된 오픈소스(GPL)로 자유롭게 설치하고 필요한 기능을 수정해 기여할 수 있습니다.
문서화 포맷으로 CHM, HTML, PDF를 지원합니다.(Configuration 화면의 Output options > Output Format에서 지정)
결과물이 썩 이쁘지는 않지만, 그렇게 나쁘지도 않습니다.
DelphiCodeToDoc(DCTD) 설치
- DCTD 다운로드 페이지(http://dephicodetodoc.sourceforge.net/Download.htm) 방문
- 다운로드 링크 클릭해 다운로드 후 압축 해제
DelphiCodeToDoc(DCTD) 실행
DelphiCodeToDoc.exe 실행 후 [New] 버튼 클릭(또는 File > New 메뉴 선택)
마법사 페이지에서 옵션 설정 및 대상 파일(또는 디렉토리) 선택 및 추가 후 [Finish]
메인화면에서 [Check and Build] 버튼 클릭(또는 Project > Check and Build 메뉴 선택)
빌드 시 CHM 도움말이 표시되고, 지정된 경로(Ouput Folder)에 지정된 포맷
결과 예시
DCTD에서 설정한 프로젝트 관련 내용 표시
프로젝트 이름을 한글로 설정 시 좌측 내용트리에 한글깨짐 현상이 있으나, 문서내에서는 정상출력 확인
프로시저에 대한 문서
@author, @version 태그 추가했지만, 문서에 표시되지 않음
웹으로 내보내기한 Unit에 대한 문서
총평
XMLDoc과 JavaDoc 주석을 추가하고 문서화 하는 내용을 살펴봤습니다.
XMLDoc은 주석에 XML 태그가 있어 코드내의 가독성은 떨어지지만, 헬프 인사이트에 표시된다는 장점이 있습니다.(단, 선언부에 주석을 달아야 합니다.
JavaDoc은 코드내 주석에 대한 가독성이 상대적으로 높지만, 헬프 인사이트 등으로 표시되지 않습니다.
문서의 결과물은 개인적으로 JavaDoc의 결과물이 더 다양하고 깔끔하다고 생각합니다.
또한 오픈소스여서 필요한 경우 직접 수정해 필요한 기능을 확장할 수 있습니다.(물론 쉽지 않습니다.)
위 내용을 종합적으로 판단한다면 저는 개인적으로 JavaDoc을 선호합니다. 이유는 XMLDoc은 선언부에 주석을 달아야 하기 때문에 구현부를 전체적으로 살펴볼때 JavaDoc의 주석 형식이 더 유용할 것으로 판단됩니다.
(또는 2개의 방식을 번갈아가며 사용해도 좋을 것 같습니다. 선언부는 XMLDoc, 구현부는 JavaDoc)
여러분들도 여러분들의 환경에 맞는 방식을 선택 해보시기 바랍니다.
참고로 위 방법 외에도 doxygen 등과 같은 주석 문서화하는 방법이 많습니다.
그리고 JavaDoc 주석을 문서화 하는 프로그램도 많을 것입니다.
혹시 아는 주석 문서화 방법이나 문서화 프로그램이 있다면 댓글로 알려주시면 감사하겠습니다.
참고 링크
