본문 바로가기
Development/Doxygen

[Doxygen]주석이 아니라 Doxygen 문법이라니....문법을 알아보아용~

by 루카오리 2013. 7. 26.
반응형

우선!!

Doxyen을 이용하여 문서를 만들려면 Doxygen이 지원하는 형태의 주석을 달아야해요..

제가 알고 있는 방식은 2~3개정도 이지만, 더 있을 수도 있어요.

저는 그냥 거기에서 만족하고 사용하고 있으니깐요~^^

제가 알고 있는 방식은 C스타일/C++스타일/Qt스타일입니다.

우선C 스타일 은 다음과 같습니다.
C스타일은 전형적인 /* */의 주석에 JavaDoc?스타일로 '*'를 두개 붙여서 사용해야 합니다.
/**
comment
*/

/** comment **/

그다음으로 C++ 스타일 은 다음과 같습니다.
C++스타일은 전형적인 주석 방법인 // 문자에 / 문자나 !문자를 를 하나더 추가 하여 사용해야 합니다. C++스타일을 추천합니다.
/// comment 1
/// comment 2
/// comment 3

//! comment 1
//! comment 2
//! comment 3

//! comment //
/// comment //
때로는 구분하기 위해서 블럭표시를 하고 사용하기도 합니다.
////////////////////////////////////////////////////////////////////////////////
/// comment
////////////////////////////////////////////////////////////////////////////////
// ----------------------------------------------------------------------------
/// comment
// ----------------------------------------------------------------------------


마지막으로 Qt스타일 은 다음과 같습니다.
Qt스타일은 *문자뒤에 !문자를 추가하여 사용하는 방법입니다.
/*!
comment 1
comment 2
*/

이제 주석명령에 대한 설명으로 들어가 볼께요~

주석명령은 '@'문자나 '\'문자를 prefix로 사용하여 표시합니다.

예를 들어 작성자 표시하는 author의 경우 \author or @author를 사용합니다~

 

자세한 설명과 예제하나를 넣어놓은 문서입니다.~^^ 참조해보세요~( doxygen 주석문법.docx)

 

또한~~첨부한 문서에 없는 주석명령의 경우 아래의 URL로 가셔서 보시면 됩니다.

URL : http://www.stack.nl/~dimitri/doxygen/manual.html

이상~~간단한 Doxygen 문서만들기를 위한 기였습니다.

반응형

댓글0