#documentation #doxygen
#Документация #doxygen
Вопрос:
С помощью doxygen я привык писать
/**
* @brief blah blah
*
* @param foo description of foo
* @param bar description of bar
* @return description of the return value
*/
int f(int foo, unsigned bar);
Но что, если я не назову один из параметров? :
int f(int, unsigned bar);
Как я могу документировать этот параметр, если я не могу ссылаться на него по имени?
Комментарии:
1. Кроме создания текстовой ссылки, это, насколько я знаю, невозможно. В чем заключается возражение против наличия имени в определении / прототипе?
2. @albert: Когда вы не используете параметр, обычно (вроде как) оставляете его безымянным.
3. Да, я знаю, но зачем вообще использовать аргумент (хотя история / совместимость — веская причина). В чем причина документирования неиспользуемого аргумента?
4. @albert: Возможно, было бы важно понять, почему эта функция вызывается с дополнительным предположительно бесполезным параметром, например (в других функциях, вызываемых аналогичным образом, это используется для XYZ, но в этой функции это не потому, что причины.»
5. Я думаю, что в этом случае здесь также должно быть ‘XYZ’ (или ‘dummy_xyz’), и описание должно объяснять, почему оно присутствует.
Ответ №1:
В настоящее время (июль 2020) Doxygen не реализует эту функциональность. Однако на странице проблем Doxygen GitHub для этого был открыт запрос функции: