visual-studio - 我可以使用 GhostDoc 将文档添加到整个类或代码文件吗？

Question

我喜欢 GhostDoc，但我希望能够为整个文件“记录这个”，而不是一次只记录一个成员。这可能吗？

Answer 1

当我最初回答这个问题时，这在 GhostDoc 或我的(类似的)插件中是不可能的，Atomineer Pro Documentation ).

(这是 Atomineer 中的一个有意的设计选择，并且大概也是在 GhostDoc 中，因为自动记录所有内容并继续前进通常是一个坏主意。这两个插件都为方法的记录提供了一个合理的起点，有时他们会提供足够好的文档，你不需要做任何调整——但大多数时候你会想要调整结果评论。如果你自动生成整个文档集，那么文档会很差，因为它们只会描述代码元素名称已经声明的内容)。

但是，现在两个插件都提供了这个功能，这在以下情况下非常有用:

• (在 Atomineer 中)在 JavaDoc、Doxygen、Qt 和 XML 文档格式之间批量转换遗留注释
• (在 Atomineer 中)在更改 AtomineerUtils 格式化选项后更新文档注释的样式/布局
• (在两个插件中)快速将框架文档添加到类中

在所有这些情况下，强烈建议您查看生成的评论，但自动更新确实可以节省大量时间。