Почему комментарий C вроде / * * / нуждается в '<'?

Question

Рекомендации C-кода моих команд пишут, что было бы лучше поместить «<» в комментарии, как показано ниже: </p>

#define MAX_PACK_ITEM_NUM 50  /**<  max number of item */

Интересно, каково реальное использование этого «<'?</p>

Answer 1

Это способ для doxygen генерировать документацию для членов файла / struct / union / class / enum.Используя этот маркер, вы можете размещать комментарии после каждого участника, что приводит к снижению беспорядка.Вы можете прочитать больше об этом здесь .

Answer 2

Как уже отвечали другие, это, вероятно, комментарий, предназначенный для doxygen.При анализе комментариев у doxygen есть несколько специальных правил:

• Обычный комментарий, начинающийся с /*, равен , игнорируется при использовании doxygen.
• Комментарий, начинающийся с /** рассматривается как документация к следующему элементу после комментария в исходном коде.
• Комментарий, начинающийся с /**<, рассматривается как документация к элементу непосредственно перед комментарий в исходном коде.

Документация в основном размещается над документированным элементом, например, функцией.Но в некоторых случаях, таких как #define, имеет смысл поместить документацию в конец строки, и в этом случае необходим маркер /**<.

Answer 3

Это синтаксис doxygen для комментирования членов после объявления / определения.

Answer 4

Я полагаю, ваша команда использует какой-то автоматизированный инструмент документирования, который ищет /**<; например Doxygen .