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

Question

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

Answer 1

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

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

然而，两个插件现在都提供此功能，这在以下情况下非常有用：

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

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

Answer 2

没有。无论如何，我仍然喜欢它。

Answer 3

使用文档文件选项：

Choose Document File Option

see the comment added for all members within the file