자주쓰는 DoxyGen 주석

 

KinsgTool을 쓰면서 자주 쓰는 DoxyGen 주석을 적어논다.

쓰다보면 더 늘어날것도 같지만 우선 아래 몇가지는 종종 쓸거 같다.

필요할경우 적절히 수정해서 사용하면 된다.

Mainpage 설명용	/** * \mainpage KingsTool 사용 예제 * \section intro 소개 * : Kingstool을 사용하는 방법 * \section Program 프로그램 설명 * : KingsTool로 문서화 되는 모습을 보이기위한 간단한 프로그램 * \section CREATEINFO 작성정보 * 만든이 : ItsMe \n * 작성일 : 2008-09-09 * \section MODIFYINFO 수정내역 * 수정자 / 수정일 : 수정내역등 \n * ItsMe / 08.09.09 : KingsTool 사용방법 테스트 클래스 추가 */
파일목록을 만들시 (파일 상단에 위치시킨다.)	/** * \file Animal.h * \date 2008/9/9 * \author ItsMe * \brief 테스트일겁니다. */
Class에 사용시 (클래스 상단에 사용)	/** * \date 2008-09-09 * \author ItsMe * \brief 강아지에 대하여 나타내는 Class */ class CDog : public CAnimal
함수에 사용시 (함수 상단에 사용)	/** * \param 설정할 강아지타입 * \return 성공여부 */ /// 강아지 종류 설정bool SetDogType(int iSetDogType){
enum을 나타낼시 (위치는 아무데나 상관없으나, 파일목록을 만드는주석 밑에 위치하는게 보기에 편할 듯 싶다.)	/** * \enum CDog::DogType * \brief enum설명 */
Enum 세부주석	class CDog : public CAnimal{ enum { DOGTYPE_BEAGLE = 0, ///< 종류 : 비글

출처 : http://blog.naver.com/sdragoon/150035138831