Visual Studio 2008 中抽象方法的 XML 注释
假设您有一个带有抽象方法的抽象类,并且您在这些方法上放置了 XML 文档标签。
当您从该类继承并实现这些方法时,智能感知不会“继承”XML 文档...?
有人知道是否可以让 IDE 继承文档吗?
如果不能,您不认为这是一种奇怪的行为吗?
我认为我可能希望通用注释通过类的实现冒泡,这是完全可以接受的……当然,如果我注释一个实现,那么应该出现它。
Say you have an Abstract Class with Abstract methods, and you place XML Documentation Tags on those methods.
When you inherit from that class, and implement those methods, intellisense does not "inherit" the XML Documentation...?
Does anyone know if its possible to make the IDE inherit the documentation?
if not, don't you think this is kind of strange behavior?
I think its quite acceptable that I might want generic comments to bubble up through implementations of a Class...and of course, if I comment an implementation, then that should appear instead.
如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱,如果其他用户或者作者回复了您的评论,将不能在第一时间通知您!
发布评论
评论(2)
GhostDoc 将自动继承文档。 这是我最喜欢的插件,仅次于 ReSharper。
Ctrl + Shift + D ... 已记录!
GhostDoc will automatically inherit the documentation. It's my #2 favorite plug-in next to ReSharper.
Ctrl + Shift + D ... documented!
您无法继承文档 - 您必须显式记录每个代码元素。
尝试 AtomineerUtils - 它是 GhostDoc 的免费替代品,功能更加强大且可配置。 除了从元素命名自动生成文档之外,它还会从任何现有文档中收集尽可能多的信息(包括重写的基类方法/属性和重载方法),以最大程度地减少文档中涉及的体力劳动量代码元素。
You can't get the documentation inherited - you have to document each code element explicitly.
Try AtomineerUtils - it's a free alternative to GhostDoc which is much more powerful and configurable. It'll gather as much information as possible from any existing documentation (both for overridden base-class methods/properties and overloaded methods), in addition to auto-generation of documentation from element naming, to minimise the amount of manual labour involved in documentation of code elements.