C# · 12月 29, 2021

c# – 在.NET中使用XML注释的优点是什么?

我不明白使用 XML注释的优点.我知道他们可以转换成代码外的漂亮文档,但是可以通过更简洁的DOxygen语法实现相同的操作.在我看来,XML的意见是错误的,因为:

他们混淆了一般的意见和代码. (他们更难阅读人类).
>可以在单个屏幕上查看较少的代码,因为“摘要”和“/摘要”需要额外的行.
>(已删除)

那么这可能是原因,为什么XML在.NET中是首选的,而不是简单的DOxygen语法?

解决方法 这里没有真正的正确答案.两个系统在现实中都不比其他系统“更好” – 他们最终都做同样的工作,这允许您生成代码文档.

最终的输出可以用完全相同的方式进行格式化,并且它们在他们支持的标签等方面具有几乎相同的功能,所以它真的在个人选择.

就我个人而言,我发现XML的意见要更加人性化,更合乎逻辑,而且简单易用 – 但是这样做的另外一个优点就是让视觉工作室自动生成存根以供我填写,并提供了极好的支持将它们折叠起来,使它们在屏幕上不占用大量空间.我相信来自VI或some_other_IDE的背景编辑的人将会有不同的意见,但是两者之间也没有真正的优势.

所以我会说,这取决于你使用什么IDE,以及你和你的团队习惯使用什么.

现在如果你问为什么微软选择在Visual Studio中如何紧密地集成XML注释,那就是一个不同的问题.很可能是由于以下事实:他们在VS中实现更简单(因为他们可以重用现有代码来生成/读取注释并构建智能感知等),它们具有坚持“标准化”的趋势“无论如何(不管是自己的还是行业的),还有杰夫提到的许可原因.

只是补充说,Microsoft在VS中使用的产品称为“Sandcastle”,这是一个内部的XML文档生成工具.它有自己的wiki页面@ http://docproject.codeplex.com/Wikipage