// doxygen 中的注释

发布于 2025-01-03 10:44:59 字数 135 浏览 1 评论 0原文

我有 ac# 项目,需要使用 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?

如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。

扫码二维码加入Web技术交流群

发布评论

需要 登录 才能够评论, 你可以免费 注册 一个本站的账号。

评论(2

番薯 2025-01-10 10:44:59

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

详细地说,如果您的代码中有类似 // This is hacky, but I'll return to it later 的注释,您应该将它们更改为有关方法、属性或对象的 XML 注释部分问题。

/// 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.

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.

念三年u 2025-01-10 10:44:59

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

To me this is not a bug but a feature. There are comments that I do want to leave in the code and not extract and show everyone. The distinction between the /// and the // allows me to do this.

~没有更多了~
我们使用 Cookies 和其他技术来定制您的体验包括您的登录状态等。通过阅读我们的 隐私政策 了解更多相关信息。 单击 接受 或继续使用网站,即表示您同意使用 Cookies 和您的相关数据。
原文