// doxygen 中的注释

Posted 2023-02-21

【中文标题】// doxygen 中的注释

【英文标题】：// comments in doxygen

【发布时间】：2012-02-28 22:02:42

【问题描述】：

我有一个需要用 doxygen 记录的 c# 项目。它会拾取由 Visual Studio 的 /// 自动生成的 cmets，但不幸的是它不会拾取正常的 // cmets。是否有我缺少的配置设置？或者这是不可能的？

【参考方案1】：

/// 被称为XML Documentation Comments。这就是 Doxygen 和其他文档生成软件如何定位您希望用作文档的代码区域。

具体来说，如果您的代码中有 // This is hacky, but I'll return to it later 这样的 cmets，您应该将它们更改为有关方法、属性或对象的 XML 注释部分。

【参考方案2】：

对我来说，这不是一个错误，而是一个特性。我确实想在代码中留下一些 cmets，而不是提取并展示给所有人。 /// 和 // 之间的区别允许我这样做。