//在doxygen中的评论

时间:2012-02-07 13:14:55

标签: c# comments doxygen

我有一个需要用doxygen记录的c#项目。它获取了visual studio ///自动生成的评论,但不幸的是它没有发现正常的//评论。是否有我错过的配置设置?或者这是不可能的?

2 个答案:

答案 0 :(得分:6)

///被称为XML Documentation Comments。这就是Doxygen和其他文档生成软件如何找到您想要的代码区域用作文档。

详细说明,如果您的代码中有// This is hacky, but I'll return to it later之类的注释,则应将其更改为有关方法,属性或对象的XML注释部分。

答案 1 :(得分:2)

对我而言,这不是一个错误,而是一个功能。有些评论我想留在代码中而不是提取并向所有人展示。 ///和//之间的区别允许我这样做。