C#.NET必备工具GhostDoc为代码生成注释文档(4)

2019-03-22 14:22

在\工具\的下拉菜单里就会出现一个\的选项,如下图:

bitscn_com

右键菜单中就会出现\命令,如下图:

feedom.net

2.2、GhostDoc的配置

在Visual Studio2005的菜单栏中选择\工具|GhostDoc|Configure GhostDoc\,弹出对话框如下图:

其中包含的属性页:

1. Rules 修改,删除,添加文本生成规则

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

3. \指定触发重新排序行为的单词 4. \指定哪些词前不使用\ 5. Options 配置GhostDoc的其他选项

GhostDoc 自动生成 XML 注释

将 XML 注释迅速添加到 Visual Studio 项目中

Microsoft? .NET Framework 通过 XML 注释简化了记录类、方法、属性及事件的任务。XML 注释是嵌入到源代码注释中的特殊 XML 标记,提供类及其成员的相关元数据。在编译过程中,此元数据会由 Visual Studio? 转换为独立的 XML 文件,然后通过使用 Microsoft Sandcastle project 之类的工具转换为帮助文件。

GhostDoc 会自动生成 XML 注释(单击该图像获得较大视图)

当 XML 注释协助将源代码注释自动转换为 RTF 帮助文档时,仍须写入注释文本,这是一项令很多开发人员感到精疲力尽的工作。为什么不使用自动化来加速这些注释的创建呢?这正是 GhostDoc 1.9.5 试图实现的目标。

GhostDoc 是一个免费的 Visual Studio 加载项,由 Roland Weigelt 创建,用来协助编写 XML 注释。一旦安装了 GhostDoc,只要使用它指一指、点一点,就能轻松地自动生成 XML 注释。例如,若要将 XML 注释添加到某个方法中,只需在该方法中右键单击,然后从上下文菜单中选择“Document This”选项。

GhostDoc 就会根据该方法的类型、参数、名称和其他上下文信息为其自动生成 XML 注释文本。

如果您正在 .NET Framework 中为使用某个类型的属性或方法生成文档,则 GhostDoc 将会使用 Microsoft 已为该类型编写的文档。如果您使用 Pascal 大小写格式或 Camel 大小写格式,GhostDoc 可将该名称拆分成几个单词,并分析这些单独的单词,以生成文档。所有的文档逻辑都按照 GhostDoc 的生成规则来处理。既可以对这些内置规则进行自定义,也可以添加新的规则。还可以导出这些规则,以便在其他计算机上使用。

除最简单的成员外,您不能完全依赖 GhostDoc 为您编写 XML 注释。GhostDoc 自动生成的注释只是建议,还需开发人员进行审核。无论如何,GhostDoc 是一个值得一试的注释编写插件,它可以节省大量时间。


C#.NET必备工具GhostDoc为代码生成注释文档(4).doc 将本文的Word文档下载到电脑 下载失败或者文档不完整,请联系客服人员解决!

下一篇:五台山风景欣赏论文

相关阅读
本类排行
× 注册会员免费下载(下载后可以自由复制和排版)

马上注册会员

注:下载文档有可能“只有目录或者内容不全”等情况,请下载之前注意辨别,如果您已付费且无法下载或内容有问题,请联系我们协助你处理。
微信: QQ: