VS2010工具之一GhostDoc

Technorati 标签: vs2010, GhostDoc

1. GhostDoc:

1.1 简介：

GhostDoc是Visual Studio的一个免费插件，可以为开发人员自动生成XML格式的注释文档。

1.2 优点：

GhostDoc使用的优点自然是可以快速生成注释，提高开发效率，但是缺点也不少，首先她生成的注释都是英文，难免有时看的会不顺眼，而且有时会无法生成准确的注释，原因在于 GhostDoc生成注释的质量很大程度上取决于标识符命名的质量，比如方法用Pascal命名法，变量用Camel命名法等，所以使用GhostDoc也可以变向的检查一下你的命名是否合理，是否足够见名之意。

1.3 缺点：

GhostDoc很强大，但也不能对它有太高的期望。它生成注释的方式也许不能很好地符合你个人的注释风格。GhostDoc也不能一次性为整个代码文件生成注释，只能每次为一个成员生成注释——GhostDoc如此设计，是因为不管怎样总需要你去检查它生成的每段注释。

1.4 原理：

• 动词：

动词的处理机制（GhostDoc假定方法名的首个单词为动词）：Add->Adds，Do->Does，Specify->Specifies；

• Of the排序机制：

ColumnWidth -> Width of the column.

一些特殊形容词的特殊合并机制：例如，MaximumColumnWidth->”Maximum width of the column”而不是”Width of the maximum column”

• 首字母：

对首字母缩写组成的常量的自动检测，并通过一个列表来处理其它的一些首字母缩写术语

使用一个单词列表，以决定何时不使用”the”：AddItem -> Adds the item, BuildFromScratch -> Builds from scratch

1.5 快捷键设定：

点击OK后，设置快捷键为Ctrl+Shift+D。

1.6 GhostDoc中的宏：

• $(Environment.Date)
• $(Environment.MachineName)
• $(Environment.Time)
• $(Environment.UserName)

1.7 简单例子：

• 如果无法识别变量的名字，GhostDoc就只会生成summary标签

• 有时代码不准确

• 如果命名合理，注释稍微准确

1.8 VS2010中使用GhostDoc工具

Rules选项卡

修改，删除，添加文本生成规则

添加一个个性类的规则

点击OK

Acronyms选项卡

指定将哪些单词视为首字母缩写词。用处不大

“Of the” Reordering选项卡

指定触发重新排序行为的单词。用处不大

“No the” Words选项卡

指定哪些词前不使用"the"。用处不大

Options选项卡:

自动生成附加注释。

转载于:https://www.cnblogs.com/liangdiamond/archive/2010/12/15/1907358.html