3

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

4

3 回答 3

3

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

(这在 Atomineer 中是有意的设计选择,大概在 GhostDoc 中也是如此,因为自动记录所有内容并继续前进通常是一个坏主意。这两个插件都为方法文档提供了一个合理的起点,有时它们会提供良好的足够多的文档,您不需要进行任何调整 - 但大多数时候您会想要调整生成的评论。如果您自动生成整个文档集,那么文档将非常糟糕,因为它们几乎不会做任何事情不仅仅是描述代码元素名称已经说明的内容)。

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

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

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

于 2009-10-04T17:46:38.373 回答
1

不,无论如何我仍然喜欢它。

于 2009-10-01T18:36:10.090 回答
1

使用文档文件选项:

在此处输入图像描述

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

在此处输入图像描述

于 2018-01-23T09:54:53.447 回答