第12章 使用XML注释生成文档

本章内容

●使用XML注释给代码添加内联文档

●使用GhostDoc Visual Studio插件自动生成XML注释

●使用Sandcastle从XML注释中生成独立的文档

●使用Task List注释跟踪挂起的编码任务和其他重要活动

文档在软件开发过程中是一个非常重要的元素，但常被轻视。没有文档，其他程序员、代码检查人员以及管理人员就很难分析代码的功能和实现方式。如果代码非常复杂，开发人员在处理自己的代码时也会出问题。优良的内部文档可以帮助改善开发过程。

XML注释可以为代码提供内部文档，而无须手动创建和维护单独的文档。只需要在编写代码时，在每个定义的顶部使用元数据来解释代码的作用。将这些信息添加到代码中后，Visual Studio可以使用它们为Object Browser和IntelliSense提供信息。

GhostDoc是Visual Studio的一个免费的第三方插件，它可以自动插入类或成员的XML注释块。

Sandcastle是用作文档编译器的一组工具。这些工具可以用Microsoft编译的HTML帮助或Microsoft Help 2格式，通过添加到代码中的XML注释，创建独立的文档。