GhostDoc 是一个 Visual Studio 扩展,适用于需要使用可自定义模板从源代码生成 XML 注释、维护干净和最新文档、生成多种格式的帮助文档、在 Visual Studio 中使用智能源代码拼写检查器等的开发人员.
GhostDoc 还有助于自动生成干净、有用的干净代码文档,构建它,并将其打包,所有这些都无需人工干预。
设置_以太网
为您的文档自动生成起点
单击一下即可为方法和类型生成智能 XML 注释。
竖起大拇指
维护干净的文档
当您更改代码时,确保用作代码文档的 XML 注释不会过时。
本地图书馆
制作多种格式的文档
只需单击一下,即可将您的 XML 文档注释转换为整个解决方案的 CHM、MS 帮助或基于 Web 的文档。
环形
来自构建的文档
对您的构建进行检测,以始终生成尽可能最新的代码文档。
简单的可视化编辑,而不是 XML 转义
点击缩放
XML 注释对于代码文档非常有用。XML 的严格性质使其很容易破坏格式,并错过所需的符号转义。
您是否曾经根据评论生成帮助文档,却发现最终结果格式不正确?文本笨拙地跑到不同的行上,或者由省略的转义字符导致的乱码文本?重新生成它直到它看起来正确是一种令人沮丧且耗时的体验。
作为软件开发人员,我们处理的已经够多了,编译和运行应用程序只是为了看到某些 GUI 组件出现问题。
为了避免这种挫败感,GhostDoc 允许您以所见即所得的方式编辑文档,并将更改保存回代码中的 XML 文档。
在实际帮助文档中进行内联编辑,以便您在进行时看到最终结果
当您满意时,将结果作为 XML 文档留在您的源代码文件中
永远不必担心手动输入转义序列或记住如何最好地格式化方法或类型摘要
主要特征
自动生成 XML 注释
单击一下即可为方法和类型生成智能 XML 注释。
视觉评论编辑器
直接在帮助文件的模型中进行更改,并让这些所见即所得的编辑自动更新您的 XML 文档注释。
简单的代码文档维护
当您更改代码时,确保用作代码文档的 XML 注释不会过时。
可定制的 XML 评论模板
准确告诉 GhostDoc 如何使用模板记录您的方法和类型,以便您立即获得所需的结果。
您首选格式的文档
只需单击一下,即可将您的 XML 文档注释转换为整个解决方案的 CHM、MS 帮助或基于 Web 的文档。
自定义帮助内容
从您的代码生成的文档开始,轻松添加您想要自定义最终产品的任何内容。
来自构建的文档
对您的构建进行检测,以始终生成尽可能最新的代码文档。
智能拼写检查
通过突出显示注释、字符串和代码中的拼写错误,避免运行时绑定错误和令人头疼的重构。
智能控制
准确定义内部团队成员和第三方用户在使用您的 API 时应在 Intellisense 中看到的内容。
代码合同兼容
应记录代码合同。GhostDoc 就是这样做的!
StyleCop 合规性
创建不与 Stylecop 冲突的代码文档。