2010-12-13 3 views
4

Когда я комментирую cvars, у меня есть тенденция использовать следующий формат, поскольку я думаю, что его легче читать.Doxygen /// комментарии в конце строки

UILabel *titleLabel; // The title label in the view 

Мой текущий клиент использует Doxygen и поэтому я возвращаюсь и преобразование моих комментариев в формат Doxygen, который я надеялся бы быть столь же просто, как

UILabel *titleLabel; /// The title label in the view 

К сожалению, это приводит комментарий привязываясь к следующему cvar.

Есть ли способ сообщить doxygen, что одиночные комментарии должны принадлежать к cvar на линии, на которой они находятся?

+0

Предположительно да, но я никогда не мог заставить его работать. Я был бы заинтересован в ответе на этот вопрос, как вы. – JeremyP

+1

Doxygen имеет довольно приличное руководство пользователя, как онлайн, так и офлайн. Если вы хотите использовать Doxygen, вы должны прочитать хотя бы некоторые его части, например, «как я могу разместить документацию в формате» http://www.stack.nl/~dimitri/doxygen/docblocks.html. – jv42

ответ

12

Я думаю, что вам не хватает <, попробуйте использовать:

UILabel *titleLabel; ///< The title label in the view 

Смотрите doxygen manual для получения дополнительной информации.

+0

Спасибо! Это избавит меня от лишнего времени. –

Смежные вопросы