如何记录ASP.net网站?

时间:2009-09-30 09:52:48

标签: asp.net visual-studio-2008 documentation

我发布了一个ASP.net网站。 如何记录? VS2008中是否有可用的工具?

如何实现?请帮帮忙?

4 个答案:

答案 0 :(得分:2)

在我看来,任何自动生成的文档都是无用的。除非您已准备好花时间并描述高级决策,结构,代码组织以及个人等其他问题,否则您可以安全地省略此部分。

答案 1 :(得分:0)

因为它提到好的文档无法自动化。所以你可以使用MS Word。对于任何类型的图表,我都会使用MS Visio。

答案 2 :(得分:0)

我找到了这个工具,他们提供免费试用版。我从来没用过它。也许它会帮助你。

http://www.innovasys.com/products/dx2008/overview.aspx

网站引言:

“Document!X自动化为各种解决方案元素创建和维护文档的过程。”

“使用Document!X,可以在整个设计和开发过程中自动生成文档,无需投入开发人员资源,为开发团队提供准确和最新的参考,并允许新开发人员跳过新组件和模式的学习曲线Document!X为开发人员和技术作家提供了生成文档的自然而富有成效的活动。“

这是其他网站关于同一工具的引用:

“Document!X 2008中包含的新功能包括与Microsoft Visual Studio 2008的兼容性,ASP.NET Ajax Javascript文档以及用于复制Microsoft Visual Studio 2008文档的全新外观的新模板。”

答案 3 :(得分:0)

您需要记录什么?

  • 设计?您可以使用sandcastle从源代码中的XML注释生成代码文件。提供设计选择和架构的详细描述不能自动化并且需要时间来记录。在必要时提供解释流程的工作流程。您可能希望将此文档拆分为高级设计和详细设计,提供功能概述,然后详细描述设计。 不要复制或解释实际代码本身(即“使用整数计数器,循环遍历......”),这就是源代码的用途。

  • 应用程序用法?同样,这是你需要花时间写作的东西。希望您已经拥有应用程序的功能规范和用例,并可以利用这些来编写用户文档。