Как называются комментарии с буквой " @ " в них?

#c #visual-studio #visual-studio-code #ide #doxygen

Вопрос:

Это случай, когда я не могу что-то найти, потому что я не знаю, как это называется. Во многих редакторах кода вы можете включить их в предыдущий блок комментариев определения, а затем получить полезный текст с помощью мыши в другом месте, или другие программы могут прочитать эти комментарии и сделать с ними что-то полезное. Я работаю над файлом, связанным с Доксигеном. Например:

     /// AskStackOverflow() - Gets answer to a question
    /// @name AskStackOverflow
    /// @brief Ask Stack Overflow
    /// @param q Question to be asked 
    /// @return Number of up votes for this cheeky comment
    int AskStackOverFlow(std::string q)
    {
       /* Some great computer codes*/
       return 1234687624;
    }

Как называется такой комментарий?
Бонусный вопрос: Это (как правило) не функция какого-либо языка, а функция пользовательского интерфейса/UX среды разработки, такой как Visual Studio, правильно?

1. Немного абстрактный вопрос, на мой взгляд, вам следует привести более явный пример, чтобы рассказать, в чем, по вашему мнению, заключается проблема в данном примере. Лучше всего всегда просматривать / читать доступную документацию.

2. Не должно быть слишком абстрактным, в конце концов, у вещи должно быть имя. Изначально я не думал, что это может быть связано с Доксигеном, я могу соответствующим образом обновить вопрос.

3. Я не уверен, чего вы хотите, но @q похоже, что вы хотите задокументировать аргумент q округления. синтаксис для этого не @q в doxygen, но вы должны использовать здесь @param q .

4. Хорошо, это полезно! Я тоже не всегда уверен, чего я хочу :p

5. Иногда у меня возникает та же проблема, что и с незнанием названия команды, но просмотр / чтение доступной документации помогает в большинстве случаев, а в противном случае приходится писать явный вопрос о stackoverflow. (увиденное позже я немного удивляюсь, почему вы приняли данный ответ, поскольку он почти не содержит информации, только ссылку на одну главу документации doxygen. Для меня также странно, что люди проголосовали против ответа)>

Ответ №1:

Я думаю, что вы ищете уценку на Доксиген

https://www.doxygen.nl/manual/markdown.html