Doxygen 中是否有等效的 @inheritDoc?
我知道 Javadoc 会编译 {@inheritDoc},但是 Doxygen 的方法是什么?
I know Javadoc will compile {@inheritDoc}, but what's the Doxygen way to do this?
如果你对这篇内容有疑问,欢迎到本站社区发帖提问 参与讨论,获取更多帮助,或者扫码二维码加入 Web 技术交流群。
绑定邮箱获取回复消息
由于您还没有绑定你的真实邮箱,如果其他用户或者作者回复了您的评论,将不能在第一时间通知您!
发布评论
评论(2)
有明确的 copydoc 我认为它最接近等效项,尽管具有更大的灵活性因此,它要求您指定要复制的原件,因此有点尴尬。它的设计目的是让您从任何地方提取文档,因此它需要一个指定源的参数。
默认情况,默认是从父类继承文档。
There's the explicit copydoc which I think is closest to an equivalent although with more flexibility it therefore requires you specify the original to copy so is a bit more awkward. It's designed to let you pull in documentation from anywhere so it needs a parameter specifying the source.
By default, the default is to inherit documentation from parent classes.
在 Doxygen 配置文件中将 INHERIT_DOCS 设置为 YES(实际上是默认值) ,只需将覆盖的成员完全取消注释,Doxygen 就会自动从基类插入文档。
@copydoc 对于您想要继承基类注释的情况很有用,但是然后添加一些特定于子类的详细信息。
With INHERIT_DOCS set to YES in your Doxygen configuration file (which is actually the default), just leave your overridden members completely uncommented and Doxygen will automatically insert the documentation from the base class.
@copydoc is useful for the case where you want to inherit base class comments, but then add some subclass-specific details.