【问题标题】:Why does a C comment like /* */ need '<'?为什么像 /* */ 这样的 C 注释需要'<'?
【发布时间】:2011-11-11 20:59:54
【问题描述】:

我的团队 C 代码指南写道,最好在评论中放置一个“

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

我想知道,这个 '

【问题讨论】:

  • 你们团队的回答是什么?
  • 人们为什么要关闭这个?这是一个完全有效的问题!
  • 可能是对文档生成器的提示..
  • 我相信很少有人从这个问题中学到东西,至于是否可以认为是本地化,meta有一个很好的答案:meta.stackexchange.com/questions/4818/…
  • @VJo:如果这是一个公司特定的约定,我会同意,但事实证明它是关于 doxygen 的——目前有 413 个问题标记为[doxygen]

标签: c++ c doxygen


【解决方案1】:

这是doxygen 为文件/结构/联合/类/枚举的成员生成文档的一种方式。通过使用该标记,您可以在每个成员之后放置 cmets,从而减少混乱。你可以阅读更多关于它的信息here

【讨论】:

    【解决方案2】:

    正如其他人所回答的那样,这可能是针对 doxygen 的评论。在解析 cmets 时,doxygen 有一些特殊的规则:

    • /* 开头的普通评论被 doxygen忽略
    • /** 开头的注释被视为源代码中注释之后的下一项的文档。
    • /**&lt; 开头的注释被视为项目的文档紧接在源代码中的注释之前。

    文档大多放置在文档项之上,例如一个函数。但在某些情况下,例如#define,将文档放在行尾是有意义的,在这种情况下需要/**&lt; 标记。

    【讨论】:

      【解决方案3】:

      这是一个doxygen syntax,用于在声明/定义后评论成员。

      【讨论】:

        【解决方案4】:

        我假设您的团队使用一些自动文档工具来查找 /**&lt;;例如Doxygen.

        【讨论】:

        • Doxygen 例如使用这些尖括号来描述成员等
        猜你喜欢
        • 1970-01-01
        • 2012-02-12
        • 1970-01-01
        • 1970-01-01
        • 1970-01-01
        • 1970-01-01
        • 1970-01-01
        • 2020-07-16
        相关资源
        最近更新 更多