강좌 & 팁
2013.11.19 10:37:32 (*.52.177.249)
19982
Doxygen을 이용해서 소스를 가지고 문서를 만들 때 사용하는 주석으로 /** ... */ 과 /// ... 이 있습니다.
/** .... */ 는 몇 개의 행을 모두 주석 처리하며 ///는 C에서 //와 같이 문자열 끝까지만 주석 처리합니다.
그래서 변수에 대해 /** ... */ 보다는 ///를 애용하는데 어떤 분은 아예 /** .... */를 사용하지 않고 ///만
사용하는 분도 계십니다.
그러나 한 가지 더 알고 있으면 편합니다. 바로 ///< 이지요.
/// 인텍스 변수 ///< 인덱스 변수
위와 같이 주석문을 추가하면 결과는 어떻게 나올까요?
kdx에 대한 내용은 정상적으로 나오지만, ndx에 대한 설명은 안 나오죠?
이는 /// 주석의 특성 때문입니다. 정확히 입력하려면 /// 주석문이 변수 앞에 와야 합니다.
즉,
/// 인텍스 변수 int ndx; ///< 인덱스 변수
이렇게 입력해야 제대로 출력됩니다. 변수에 대한 주석은 변수 다음에 설명하는 것이 보기 좋으므로
변수에 대한 설명은 /// 보다는 ///<을 사용하는 것이 좋습니다.
