使用GhostDoc为代码生成注释文档

核心提示： 下面是应用GhostDoc的一些例子： /// <summary> /// Determines the size of the page buffer. /// </summary> /// <param name="initialPageBuff

下面是应用GhostDoc的一些例子：

　　 /// <summary>
　　　 /// Determines the size of the page buffer.
　　　 /// </summary>
　　　 /// <param name="initialPageBufferSize">Initial size of the page buffer.</param>
　　　 /// <returns></returns>
　　　 public int DeterminePageBufferSize(int initialPageBufferSize)
　　　 {
　　　　　　　 return 0;
　　　 }

　　　 /// <summary>
　　　 /// Adds the specified item.
　　　 /// </summary>
　　　 /// <param name="item">The item.</param>
　　　 public void Add(string item)
　　　 {
　　　　　　　 //does something
　　　 }

　　　 /// <summary>
　　　 /// Appends the HTML text.
　　　 /// </summary>
　　　 /// <param name="htmlProvider">The HTML provider.</param>
　　　 public void AppendHtmlText(IHtmlProvider htmlProvider)
　　　 {
　　　 }　　

是不是惊人的准确？

GhostDoc生成注释的质量很大程度上取决于标识符命名的质量，

所以长期使用GhostDoc，也会让你学会编写一致的和自解释的标识符，不亦乐乎？

GhostDoc不能做什么？

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

GhostDoc的配置：　　

在Visual Studio菜单栏中选择Tools->GhostDoc->Configure GhostDoc。

其中包含如下几个属性页：

<!--[if !supportLists]--> <!--[endif]--><!--[if !supportLists]-->

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

Acronyms ： 指定将哪些单词视为首字母缩写词

"Of the" Reordering ： 指定触发重新排序行为的单词

"No the" Words ： 指定哪些词前不使用”the”

Options ： 配置GhostDoc的其它选项