Як слід класифікувати typedef за допомогою Doxygen?

У мене є typedef структури в моєму C + + код. На даний момент вони наведені як \ var 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 . Що ще є для використання?

7
@ Pubby8: typedef s як і раніше використовується в C ++, щоб покращити читання коду. Однією популярною утилітою typedef є створення вказівників до функцій. Інший з шаблонів.
додано Автор Thomas Matthews, джерело
@ Pubby8: В першу чергу дозволено зробити C-код портування простішим. Мова C ++ переносить багато синтаксису C, і це один з них. Це не заважає коду і не впливає на виконуваний файл.
додано Автор Thomas Matthews, джерело
Чому typedef ? Це C ++, а не C.
додано Автор Pubby, джерело
@ThomasMatthews Я розумію використання typedef таким способом, але чому typedef struct замість struct ?
додано Автор Pubby, джерело

2 Відповіді

Якщо ви помістите блок коментаря перед typedef, вам не потрібно використовувати спеціальну команду.

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

Якщо ви віддаєте перевагу розмістити його після typedef, використовуйте наступне:

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

Тільки тоді, коли блок коментарів повинен знаходитись в іншому місці, ніж фактичний typedef, вам слід скористатися \ typedef.

21
додано

Відповідно до документації Doxygen існує \ typedef . Команда веде себе так само, як і команда \ var .

10
додано
IT KPI C/С++ новым годом
IT KPI C/С++ новым годом
747 учасників

Чат обсуждения С/С++. - Вопросы "напишите за меня лабу" - это оффтоп. - Оффтоп, флуд, оскорбления и вбросы здесь не приняты. - За нарушение - предупреждение или mute на неделю. - За спам и рекламу - ban. Все чаты IT KPI: https://t.me/itkpi/1147