코드 문서화

작성: http://ospace.tistory.com/,2011.01.07 (ospace114@empal.com)

아래 내용은 예전에 작성한 내용이다. 다시 조만간 정리해야할 것 같다.

Doxygen도 사용하기 조금 복잡한 형태이다. 다른 표기형태도 고려가 필요하다.

Doxygen

헤더파일 주요 설명

/*

\헤더파일 대표 이름
!헤드라인
주요설명
  -.\ \n
  -.\ \n
*/

클래스나 구조체 설명

/** 타이틀
설명
  \auth 작성자
  \todo 해야할일
*/

함수 설명

//! 타이틀 및 간력 설명
//! 추가설명
//! \return 리턴값
int func (int n1, ///< 인자1 설명
             int n2, ///< 인자2 설명
            )
{
  int num; ///< 변수명
}

기타

/**
여러줄 설명
*/
/*!
여러줄 설명
*/

열거형 설명

enum bar {
  num1, ///< 설명1
  num2 ///< 설명2
};

JavaDoc

클래스와 함수 설명

/**
 * 설명
 * <ul>
 * <li> 리스트 (see <a href="#setParam">setParam</a>
 * </ul>
 * { @link 클래스명 } <-- 클래스 링크
 * @param 인자1 인자설명
 * @param 인자2 인자설명
 * @return 반환값
 * @auth 작성자1
 * @version %I%, %G%
 * @exception 발생예외
 * @see 참조 클래스
 */

%I%: get incremented each time you edit and deget a file

%G%: is the date mm/dd/yy

기타설명

/**
 * 설명
 */

C#

XML Documentation Comments (C# Programming Guide)

http://msdn.microsoft.com/en-us/library/b2s063f7.aspx

관련자료

[1] Kyuseo’s C++ Comment Style Guideline with Doxygen, http://k.daum.net/qna/openknowledge/view.html?qid=3ZX9h&l_cid=

[2] Doxygen formatting conventions, http://drupal.org/node/1354

[3] Doxygen commands, http://www.stack.nl/~dimitri/doxygen/commands.html