Doxygen으로 typedef를 어떻게 분류해야합니까?

내 C++ 코드에 typedef 구조체가 있습니다. 현재로서는 \var typedef로 나열되어 있습니다. 이 작업을 수행하는 더 좋은 방법이 있습니까?Doxygen으로 typedef를 어떻게 분류해야합니까?

/*! \var typedef etc 
* \brief A type defined structure for etc 
* 
* \param x type- Variable declaration for x 
* \param y type- Variable declaration for y 
*/

나는 심지어 param 말을하지 않아야 알고 : 아래 내가 가진 것의 예이다. 그 밖의 무엇을 사용할 수 있습니까?

출처

2011-10-28 Questioneer

왜 'typedef'입니까? 이것은 C가 아니라 C++입니다. – Pubby

@ Pubby8 :'typedef'는 코드 가독성을 높이기 위해 C++에서 여전히 사용됩니다. 'typedef'의 한가지 대중적인 사용은 함수에 대한 포인터를 만드는 것입니다. 다른 하나는 템플릿입니다. –

@ThomasMatthews 그런 식으로 typedef를 사용하는 것을 이해할 수 있지만,'struct' 대신'typedef struct'를 사용해야하는 이유는 무엇입니까? – Pubby

Doxygen documentation에 따르면 \typedef 명령이 있습니다. 이 명령은 \var 명령과 동일하게 작동합니다.

출처

2011-10-28 18:32:20

typedef 앞에 주석 블록을두면 특별한 명령을 사용할 필요가 없습니다.

/** This is the documentation for the following typedef */ 
typedef MyClass MyTypedef;

는 다음과 같은 사용 형식 정의 후에 넣어 선호하는 경우 : 주석 블록은 실제 타입 정의가 아닌 다른 위치에 있어야합니다 때

typedef MyClass MyTypedef; 
/**< This is the documentation for the preceding typedef */

만, 당신은 \ 형식 정의 사용해야합니다.

출처

2011-10-29 14:46:26 doxygen

Doxygen으로 typedef를 어떻게 분류해야합니까?

답변

관련 문제