【问题标题】:funny looking comments - c++有趣的评论 - C++
【发布时间】:2020-12-31 17:42:12
【问题描述】:

当我阅读开源项目的源文件时,我经常在 cmets 中遇到一些奇怪的短语

/*       
@brief ......  
@usage.....  
@remarks....  
@par....  
*/

问题
1.它们是什么?(我在学习c++时没有提到)
2.他们有任何文件吗(在哪里)

【问题讨论】:

  • 虽然,Doxygen cmets 实际上是用 /** 或 /// 而不是 /* 和 /// 标记的

标签: c++ c visual-c++


【解决方案1】:

它们只是 cmets,因此在 C++ 中没有特殊含义。他们可能会允许文档生成器(例如Doxygen)从 cmets 中提取数据。

【讨论】:

    【解决方案2】:

    这些是一些自动文档生成器的味道。另一个程序运行代码,寻找与您在此处看到的类似的 cmets。 @... 关键字标识文档的布局方式,该程序直接从源代码生成漂亮的 HTML 或打印文档。这是一种更轻松地使文档与代码保持同步的方法。

    【讨论】:

      猜你喜欢
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 2020-01-09
      • 2012-04-29
      • 1970-01-01
      • 1970-01-01
      • 2021-02-20
      相关资源
      最近更新 更多