Multi-bullet Doxygen @note?

Question

В не-Doxygen комментарии, я часто:

/* Lorem ipsum etc. 
* 
* Notes: 
* - A first note. 
* - Some other note note. 
*/ 

Но с Doxygen, у меня есть @note (или \note), не @notes). Итак, следует ли использовать несколько @note s, или я помещаю все примечания под тем же @note?

Answer 1

Вы можете сделать это в любом случае; это действительно вопрос стиля/предпочтения.

Как вы указали, Doxygen имеет команду @note, но не @notes. Вы можете создать свою собственную команду для @notes пути редактирования Doxyfile и модификаций ALIASES = тег для чтения

ALIASES = "notes=@par Notes:\n" 

С этим, вы можете поместить команду @notes в документации, что приведет к определенному пользователю пункта с в товарной позиции

Примечания:

Как указано в Doxygen documentation for the ALIAS tag, вы можете Поместите \ n в значение, чтобы псевдоним вставлял новые строки.

Answer 2

Команда @note приводит к абзацу, формат которого можно настроить в файле CSS или в файле стиля при использовании Latex. Таким образом, вы можете просто использовать наценки как в «нормальный» текст:

/** 
* Bla bla... 
* 
* @note Even in a note you can use markups: 
*  - Your first note 
*  - Youre second note 
* 
* The note section ends with an empty line or the end of the comment. 
*/