C# 中是否禁止使用 doxygen 风格的文档注释?

发布于 2024-10-30 17:44:33 字数 1431 浏览 8 评论 0原文

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

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

发布评论

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

评论(2

紙鸢 2024-11-06 17:44:33

如果你想要智能感知,那么你必须使用 XML 注释。 Visual C# 编译器无法识别或理解 Doxygen。

如果您想使用 XML 注释生成 HTML 文档,请使用 Sandcastle ——这就是它的用途。

If you want intellisense, then you have to use the XML comments. The Visual C# compiler does not recognize or understand Doxygen.

If you want to use the XML comments to generate HTML documentation, use Sandcastle -- that's what it's for.

泼猴你往哪里跑 2024-11-06 17:44:33

查看我的文档插件,AtomineerUtils

它可以读取 Doxygen 注释并将其转换为 XML 文档格式。它将在一次传递中处理整个范围块,因此可用于将遗留文档快速转换为不同的格式。

它也非常可配置,因此您可以调整输出以使其尽可能可读。

Check out my documentation addin, AtomineerUtils.

It can read Doxygen comments and convert them into the XML Documentation format. It'll process entire scope blocks in a single pass, so can be used to quickly convert legacy documentation to a different format.

It's also very configurable, so you can tweak the output to make it as readable as possible.

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