12.4 用GhostDoc生成文档

尽管大多数开发人员都认为文档很重要，但编写文档仍需要耗费很多时间和精力。黄金规则“如果很容易，开发人员就更倾向于完成它”意味着，在文档开发方面的任何改进都鼓励更多的开发人员编写文档。

GhostDoc是Visual Studio的一个插件，它可以设置一个快捷键，自动插入类或成员的XML注释块。但GhostDoc的真正威力并不在于其创建基本存根的能力，而在于自动制作文档的一个非常好的部分。

通过一系列列表定制成员和变量名的不同部分的解释方式，GhostDoc生成了简单的短语，以便用户开始创建自己的文档。例如，考虑如图12-3所示的列表（通过Tools | GhostDoc | Options菜单项即可显示该对话框），它把单词定义为Of the短语的触发点。只要变量名或成员名包含字符串color， GhostDoc就尝试创建一个可以在XML文档中使用的短语。

图12-3

例如，NewBackgroundColor属性会生成一个完整的短语New color of the background。GhostDoc还能识别常见的参数名及其作用。图12-4用按钮控件的Click默认事件处理程序说明了这一点。在事件处理程序中，sender和e参数被识别为特殊类型，GhostDoc生成的文档反映了这一点。

图12-4

如果用户觉得编写文档很难，GhostDoc就是一个非常好的资源，它的官方网站是http://submain．com/ghostdoc。