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

Posted 2023-03-31

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

【英文标题】：Can I use GhostDoc to add documentation to an entire class or code file?

【发布时间】：2010-12-03 02:28:45

【问题描述】：

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

【问题讨论】：

我没有在我最近购买的机器上重新安装 ghost doc。我尝试过这个。不喜欢。 R# 在“鬼写”通用 cmets 方面做得更好，它们通过了 stylecop 格式。

您现在实际上可以使用 GhostDoc Pro 做到这一点 - 它引入了文档文件、文档类型命令和灵活的基于 T4 的注释模板

您不能使用 GhostDoc 添加文档，句号。它所做的只是增加无意义的文件大小。

【参考方案1】：

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

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

不过，现在两个插件都提供了这个功能，这在以下情况下非常有用：

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

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

【讨论】：

“有时他们会提供足够好的文档，您不需要进行任何调整”根据我使用 GhostDoc 和使用库“评论”它的经验，我认为而不是 有时 你的意思是说从不。

两件事。 1）现在可以在 GhostDoc 中使用，2）最好声明您是 AtomineerUtils 的开发人员

@ChaseFlorell - 你在这两个方面都是对的。我通常会尽力说明这一点。我已经编辑了 mny 答案以使其与最新发展保持同步。

【参考方案2】：

没有。不管怎样，我仍然喜欢它。

【讨论】：

这不再正确。 GhostDoc Pro 有一个“文档文件”菜单选项。

【参考方案3】：

使用文档文件选项：

查看为文件中所有成员添加的评论：