将 XML 注释迅速添加到 Visual Studio 项目中
Microsoft® NET Framework 通过 XML 注释简化了记录类方法属性及事件的任务XML 注释是嵌入到源代码注释中的特殊 XML 标记提供类及其成员的相关元数据在编译过程中此元数据会由 Visual Studio® 转换为独立的 XML 文件然后通过使用 Microsoft Sandcastle project 之类的工具转换为帮助文件
) thissrc=small; if (currentindexOf(small) > )thissrc=large;>
GhostDoc 会自动生成 XML 注释(单击该图像获得较大视图)
当 XML 注释协助将源代码注释自动转换为 RTF 帮助文档时仍须写入注释文本这是一项令很多开发人员感到精疲力尽的工作为什么不使用自动化来加速这些注释的创建呢？这正是 GhostDoc 试图实现的目标
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 是一个值得一试的注释编写插件它可以节省大量时间
