ghost使用方法,ghost常用
一.导言
GhostDoc是Visual Studio的免费插件，可以为开发者自动生成XML格式的注释文档。
第二，下载
有需要的朋友可以去这里下载，只需填写一个邮箱地址：GhostDoc
三。装置
下载完成后，可以在Visual Studio的工具菜单下找到GhostDoc。
第一次使用时，会要求您设置快捷键。默认值为Ctrl Shift S。如果这与您设置的快捷键冲突，您可以从下拉列表中选择另一个快捷键。
GhostDoc的优点是可以快速生成评论，提高开发效率，但也有很多缺点。首先，她生成的评论都是英文的，难免有时候看着不舒服，有时候也不能生成准确的评论。原因是GhostDoc生成的注释质量很大程度上取决于标识符命名的质量，比如方法的Pascal命名和变量的Camel命名。所以使用GhostDoc也可以改变方向，检查你的命名是否合理。
如果您的类成员是用于实现接口或覆盖基类的成员，GhostDoc将使用现有的文档，不管这些接口或基类来自哪里。如果没有可用的现有文档，GhostDoc将尝试“猜测”如何为您生成注释。当然，精度可能取决于RP。
四。使用
1.如果不能识别变量的名称，GhostDoc只会生成summary的标签，光标会移动到空白的注释内容：
2.有时候生成的评论会不准确或者不符合个人习惯：
3.如果名字合理，当然可以准确生成评论：
动词（verb的缩写）自定义配置
除了简单的使用之外，您还可以到GhostDoc进行自定义配置：
的配置方法在安装目录下有一个GhostDoc帮助文档，可以根据文档进行详细设置。这里有一个简单的例子：
1.先说最后一个选项选项卡，因为感觉比较实用。这里可以自动生成附加注释。这里有一个自定义文本的文本框，你可以在这里输出你想要的注释，也可以点击旁边的按钮使用系统定义的宏变量，如下图所示：
生成的注释如下：
呵呵，感觉不错。
2.先说第一个“规则”页签，也是最重要的一个。点击这里打开一个有代表性的：
在描述中，您可以看到该规则将检测以can开头的返回布尔值。下面是返回的模板和生成的总结评论模板。优先级最高的会先出现，如果和第一个不匹配，会依次向下搜索。
这可能是配置最复杂的地方，但也是要求最高的地方。以添加一个简单的个性方法为例：
单击Add on Methods，然后填写您喜欢的任何名称，然后输入方法配置：
配置完成后，可以进行下面的简单测试。
然后进入类型配置：
必要时也可以配置参数，方法类似。
然后配置摘要标签的模板，例如：
或者您可以单击“后退”按钮选择系统定义的宏。
好了，结果是这样的：
我们得到了想要的结果。^_^
3.第二页签是缩写的设置。在这里，它指的是GhostDoc将尝试检测的缩写词。比如BuildHTMLText()方法中的Html会被解释为Html，但它只自动处理辅音字幕，其他单词必须在这个对话框标签的配置表中完成。
例如：
然后将UML添加到规则中，并重新生成注释，如下所示：
4.例如，如果在这里定义了size，像“FileBufferSize”这样的词将被注释为“文件缓冲区的大小”。好像我没什么好定制的。
5.没有the Word:ghost doc创建注释时，会在标识名前创建一个，而不会创建该选项卡列表中显示的内容。效果如下：
当没有添加规则时：
添加myx以输入此规则并重新生成注释：
这个好像有点无伤大雅，估计外国人也会在意这个，所以才制定了这样的规定。
不及物动词其他技能的例子
GhostDoc会自动检测继承和重写的方法注释，这大大简化了操作。
示例1:继承
这里，定义一个简单的属性来查看注释的效果：
重写时看注释的效果：
哈哈，已经可以得到我们之前评论的内容了。
这里需要注意的是，必须使用summary annotation标签，简单的//annotation GhostDoc将被忽略。
示例2:重写
如果你坚持GhostDoc不能生成中文评论，那也是错的。事实上，如果你安装了中文版的VS，你就可以用中文生成评论，比如这里。
继承了系统下的ControlBuilder类。Web.UI，并准备重写HtmlDecodeLiterals()方法。首先看一下VS目前的智能提示：
现在生成评论并查看效果：
是的，标注很标准，就像字迹一样。
好了，以上就是项目中Visual Studio插件GhostDoc的使用。如果以后有机会外包，估计这个东西的用处可能会更大。继续努力。^_^
来自：http://www . cn blogs . com/rocky myx/archive/2010/04/20/Project-Route-Using-ghost doc . html
