【问题标题】:Readable generated xml comments可读生成的 xml 注释
【发布时间】:2010-11-08 07:53:13
【问题描述】:

是否有一些简单、标准的方法可以将我的 C# xml cmets 生成的 xml 文件转换为易于阅读的格式。我不需要设置任何格式,添加新标签等,我只需要显示我生成的文件,例如。 javadoc 风格或不相似,以最简单、最简单的方式。干杯。

【问题讨论】:

  • 澄清一下,我已经从我的 cmets 生成了一个 xml 文件,但它通常不可读。我可以通过将其转换为 html 或类似的工具或类似工具轻松运行此文件吗? Javadoc 自动将生成的文件设置为“可读”的样式。

标签: c# xml visual-studio api comments


【解决方案1】:

我使用SandcastleSandcastle Help File Builder,它们从 xml doc cmets 生成 MSDN 样式的帮助文件。您可以找到详细指南here

另一个选项是Doxygen,我发现它比 Sandcastle 更容易使用。最后,我更喜欢 Sandcastle 生成的帮助文件的外观,所以我选择了 Sandcastle 而不是 Doxygen。

【讨论】:

  • 我一直在使用 Doxygen,发现它在从代码中提取文档和展示文档方面都非常有用。它功能强大且易于使用。
【解决方案2】:

您可以使用Ghost Doc

【讨论】:

    【解决方案3】:

    您有多种工具可以做到这一点:

    1. NDoc
    2. Devscribe

    您可以获得许多其他文档生成器的列表here

    【讨论】:

      猜你喜欢
      • 2013-08-01
      • 1970-01-01
      • 1970-01-01
      • 2012-10-27
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 2014-04-03
      • 1970-01-01
      相关资源
      最近更新 更多