// doxygen中的注释 [英] // comments in doxygen

问题描述

我有一个c＃项目，我需要与doxygen记录。它接受visual studio的 /// 自动生成的注释，但不幸的是它不能接受正常的 // 注释。有没有我缺少一个配置设置？或者这是不可能的？

I have a c# project that I need to document with doxygen. It picks up the comments autogenerated by visual studio's /// but unfortunately it does not pick up on the normal // comments. Is there a config setting that I am missing? Or is this just not possible?

推荐答案

/// 作为 XML文档注释。这是Doxygen和其他文档生成软件如何定位您需要的代码区域。

/// is referred to as XML Documentation Comments. This is how Doxygen and other documentation-generating software locate areas of the code you want to be used as documentation.

要详细说明，如果有 //这是hacky，但我会在你的代码中返回，你应该将它们更改为一个XML注释部分的方法，属性或对象

To elaborate, if you have comments like // This is hacky, but I'll return to it later in your code you should change them to an XML comment section on the method, property, or object in question.

这篇关于// doxygen中的注释的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！