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”选项。