develop:doc:doxygen:docblocks

문서의 이전 판입니다!

목차

Doxygen Special Documentation Blocks
- special documentation blocks
  - 상세설명 주석블럭 표시방법
  - 간략설명 주석블럭을 표시하는 방법

Doxygen Special Documentation Blocks

special documentation blocks

special documentation blocks(SDB)은 몇몇 추가된 표시를 가진 C 또는 C++ 주석 블럭을 말하며, 이렇게 함으로서 doxygen은 생성될 문서내에 표시될 문서 부분을 알수 있게 됩니다.
각각의 코드 아이템에 대하여 두가지 설명 형식이 존재하며, 이들이 모두 묶여서 문서를 형성하게 됩니다 : 간략 설명, 상세 설명을 말하며, 이들 모두 선택사항입니다.
그러나 하나 이상의 간략 또는 상세 설명을 가지는 것은 허용되지 않습니다.
용어 뜻에서 알 수 있듯이, 간략 설명은 짧은 한줄짜리 설명을 말하며 상세 설명은 더 길고 더 상세한 문서를 제공합니다.

상세설명 주석블럭 표시방법

두개의 '*'으로 시작하는 C스타일 주석문을 포함함으로서 JavaDoc 스타일을 다음과 같이 사용할 수 있습니다
```
/**
 * ... 문장 ...
 */
```
또는 Qt 스타일을 사용할 수 있습니다. 이때는 아래 예와 같이 C 스타일 주석문처음에 ! 문자를 추가합니다.
```
/*!
 * ... 문장 ...
 */
```
중간의 '*'문자는 선택사항입니다. 즉, 다음과 같이 해도 적법하게 처리합니다. (redpixel이 선호하는 방법)
```
/*!
 ... 문장 ...
*/
```
세번째 방법은 최소 두개의 C++ 주석 줄을 붙여 사용하는 방법입니다.
이때 각 줄은 <color red>//</color> 다음에 <color red>/</color>나 <color red>!</color>문자를 하나 더 붙여주어야합니다.
```
///
/// ... 문장 ...
///
```
또는
```
//!
//!... 문장 ...
//!
```
몇몇 개발자들은 문서안에서 더 눈에 띄도록 주석 블럭을 만들기를 좋아합니다. 이렇게 하려면 다음과 같이 합니다
```
/////////////////////////////////////////////////
/// ... 문장 ...
/////////////////////////////////////////////////
```

간략설명 주석블럭을 표시하는 방법

@brief 명령을 주석 블럭의 상단에 넣는 방법입니다.
이 명령은 단락의 끝에서 효과가 종료됩니다.
그러므로 간략 설명을 넣고 한줄 띄워줘야 그 이후를 세부설명으로 간주하게 됩니다.
```
/*! \brief 간략설명.
 *         계속된 간략설명.
 *
 *  세부설명 시작.
 */
```
JAVADOC_AUTOBRIEF를 YES로 설정했다면, javaDoc 스타일 블럭방식을 사용할 경우 자동적으로 첫번째 문장(.으로 끝나는 문장)을 간략설명으로 간주합니다.
```
/** 간략설명은 다음 마침표까지로 간주합니다. 상세 설명은
 *  지금부터 처리됩니다.
 */
```
이 옵션은 여러줄의 C++ 주석에서도 같은 효과를 가집니다.
```
/// 간략설명은 다음 마침표까지로 간주합니다. 상세 설명은
/// 지금부터 처리됩니다.
```
A third option is to use a special C++ style comment which does not span more than one line. Here are two examples:
```
/// Brief description.
/** Detailed description. */
```
또는
```
//! Brief descripion.

//! Detailed description 
//! starts here.
```
Note the blank line in the last example, which is required to separate the brief description from the block containing the detailed description.
The JAVADOC_AUTOBRIEF should also be set to NO for this case.

develop/doc/doxygen/docblocks.1311036181.txt.gz · 마지막으로 수정됨: 2011/07/19 09:43 저자 starlits