生成 C# 文档而不构建 Xml 文档 [关闭]

2024-03-14

首先,我见过从 C# XML 注释生成文档 https://stackoverflow.com/questions/48381/generating-documentation-from-c-xml-comments和许多其他人喜欢它,但建议的工具都不能满足我的需要。

我需要一个免费工具,可以从我的源代码生成文档(最好是 html 格式),而无需使用 Visual Studio 创建的 xml 文档。该项目在打开错误时会发出警告,并且检查生成该 xml 文件的选项会产生数百个错误。实际上,这排除了 90% 的 C# 文档生成器,包括 Sandcastle、NDoc3、Live Documenter、docu 和 ImmDoc。

Doxygen 几乎可以工作,但我似乎无法让它为重载的泛型类生成文档,例如:

public class MyClass<Foo>
public class MyClass<Foo, Bar> : MyClass<Foo>

MyClass 有文档,但 MyClass 没有。

那么问题来了——有没有:

  1. 我还没有见过可以处理这种情况的文档生成器,
  2. 我列出的工具之一中的配置选项可以使其在不需要 xml 文档文件的情况下工作,
  3. 甚至是关闭的方法just注释编译器警告而不影响构建警告?

Edit.通过方法#3的解决方案是抑制与xml注释相关的以下警告:1570、1571、1572、1573、1574、1580、1581、1584、1587、1589、1590、1591、1592、1598、1710、1711 , 1712, 1723


您可以禁用warning 1591 http://msdn.microsoft.com/en-us/library/zk18c1w9.aspx在项目属性中,然后生成 XML。

本文内容由网友自发贡献,版权归原作者所有,本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容,请联系:hwhale#tublm.com(使用前将#替换为@)

生成 C# 文档而不构建 Xml 文档 [关闭] 的相关文章

随机推荐