【问题标题】:What is the name for comments with '@' in them?带有“@”的评论的名称是什么?
【发布时间】:2021-08-14 19:05:51
【问题描述】:

这是因为我不知道它的名称而无法查找的情况。在许多代码编辑器中,您可以将这些包含在定义的前面的注释块中,然后在其他地方获得有用的鼠标悬停文本,或者其他程序可以读取这些 cmets 并使用它们做一些有用的事情。我正在处理与 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;
    }

这种评论的名称是什么? 额外问题:这些不是(通常)任何语言的功能,而是 IDE(例如 Visual Studio)的 UI/UX 功能,对吗?

【问题讨论】:

  • 有点抽象的问题,在我看来,你应该给出一个更明确的例子,告诉你认为问题出在给定例子的什么地方。最好总是浏览/阅读可用的文档。
  • 不要太抽象,毕竟东西得有个名字。最初我没有考虑它可能与 Doxygen 有关,我可以相应地更新问题。
  • 我不确定你想要什么,但@q 看起来你想记录日常的参数q。这个语法不是 doxygen 中的@q,而是你应该在这里使用@param q。
  • 好的,这很有帮助!我也不总是确定我想要什么:p
  • 有时我会遇到同样的问题,因为我不知道命令的名称,但是浏览/阅读可用的文档在大多数情况下确实有帮助,否则必须写一个明确的问题堆栈溢出。 (看到后面我很想知道你为什么接受给出的答案,因为它几乎不包含信息,只有一个链接到 doxygen 文档的一章。对我来说,人们赞成这个答案也很奇怪)>

标签: c++ visual-studio visual-studio-code ide doxygen


【解决方案1】:

我认为您正在寻找的是 Doxygen ma​​rkdown

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

【讨论】:

  • 你能说出为什么 OP 可能正在寻找降价,例如不是为了使用的命令的名称?
猜你喜欢
  • 2011-12-10
  • 1970-01-01
  • 2018-05-04
  • 2017-09-27
  • 1970-01-01
  • 2011-11-18
  • 1970-01-01
  • 1970-01-01
  • 2015-10-08
相关资源
最近更新 更多