【问题标题】:how should I document my application [closed]我应该如何记录我的申请[关闭]
【发布时间】:2010-09-08 15:29:28
【问题描述】:

我们在 c# .net 中开发了一个应用程序,旨在使其可部署在我们的 Intranet 中。我们希望有一个可靠的文档来配合它,但不确定记录它的最佳平台。有什么工具可以促进这个过程?

我发现了有关 Doxygen、Htmlhelp 或 Dr Explain 的信息,但我仍然不知道该使用什么。

【问题讨论】:

  • 您希望提供哪类文档?对于应用程序用户?对于应用程序支持? (服务台等)用于开发? (可重复使用的库,或进一步开发)
  • 开发者和用户设置系统的说明

标签: .net documentation code-documentation


【解决方案1】:

如果想生成类似于 MSDN 的东西,你可以试试 Sandcastle(由 Microsoft 创建)。

您可以为用户使用Help File Builder,如果您的应用程序是其他开发人员的共享库,您可以使用Documentation Compiler for Managed Class Libraries(尽管根据您的描述,您可能希望使用帮助文件生成器)。

【讨论】:

    【解决方案2】:

    如果你想要类似 MSDN 的代码文档,也可以试试VSdocman

    【讨论】:

      猜你喜欢
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 1970-01-01
      • 2015-04-28
      • 1970-01-01
      • 2020-07-06
      • 2020-10-12
      • 2011-06-07
      相关资源
      最近更新 更多