Почему комментарий C нравится /* */need '<'?
Мои команды C-code пишут, что было бы лучше разместить '<' в комментарии, как показано ниже:
#define MAX_PACK_ITEM_NUM 50 /**< max number of item */
Интересно, каково реальное использование этого '<'?
Ответы
Ответ 1
Это способ для doxygen
сгенерировать документацию для членов файла /struct/union/class/enum. Используя этот маркер, вы можете размещать комментарии после каждого участника, что приводит к снижению беспорядка. Вы можете прочитать больше об этом здесь.
Ответ 2
Как ответили другие, это, вероятно, комментарий, который предназначен для doxygen. При анализе комментариев у doxygen есть специальные правила:
- Обычный комментарий, начинающийся с
/*
, игнорируется doxygen.
- Комментарий, начинающийся с
/**
, рассматривается как документация следующего элемента после комментария в исходном коде.
- Комментарий, начинающийся с
/**<
, рассматривается как документация элемента непосредственно перед комментарием в исходном коде.
Документация в основном размещается над документированным элементом, например. функция. Но в некоторых случаях, таких как #define
, имеет смысл разместить документацию в конце строки, и в этом случае необходим маркер /**<
.
Ответ 3
Это синтаксис doxygen для комментирования членов после объявления/определения.
Ответ 4
Я предполагаю, что ваша команда использует какой-то автоматизированный инструмент документирования, который ищет /**<
; например, Doxygen.