我可以使用 GhostDoc 将文档添加到整个类或代码文件中吗?
我喜欢 GhostDoc,但我希望能够为整个文件“记录此内容”,而不仅仅是一次只记录一个成员。这可能吗?
I love GhostDoc, but I want to be able to "Document This" for an entire file, and not just one member at a time. Is this possible?
如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱,如果其他用户或者作者回复了您的评论,将不能在第一时间通知您!
发布评论
评论(3)
当我最初回答这个问题时,这在 GhostDoc 或我的(类似)插件 Atomineer Pro Documentation)。
(这是 Atomineer 中的有意设计选择,大概也是 GhostDoc 中的设计选择,因为自动记录所有内容并继续前进通常是一个坏主意。这两个插件都为方法的文档提供了合理的起点,有时它们将提供足够好的文档,您不需要进行任何调整 - 但大多数时候您会想要调整生成的注释,如果您自动生成整个文档集,那么文档将非常糟糕,因为它们。只会描述代码元素名称已经说明的内容)。
但是,两个插件现在都提供此功能,这在以下情况下非常有用:(
在所有这些中在这种情况下,强烈建议您查看生成的注释,但自动更新确实可以节省大量时间。
When I originally answered this question, this was not possible in GhostDoc, or in my (similar) addin, Atomineer Pro Documentation).
(This was an intentional design choice in Atomineer, and presumably also in GhostDoc, because it's a generally bad idea to document everything automatically and move on. Both these addins produce a reasonable starting point for documentation of a method, and sometimes they will provide good enough documentation that you don't need to make any adjustments - but most of the time you will want to tweak the resulting comment. If you auto-generate the entire documentation set, then the docs will be pretty poor, because they will do little more than describing what the code element names already state).
However, both addins now now provide this feature, which is very useful in the following situations:
In all these situations it is strongly recommended that you review the resulting comments, but automating the update does save a lot of time.
不,无论如何,我仍然喜欢它。
No. I still love it also regardless.
使用文档文件选项:
查看为文件中所有成员添加的注释:
Use document File Option:
see the comment added for all members within the file: