DOORT-被覆盖的方法-注释不是继承的，为什么？ [英] Doxygen - overridden method - the comment is not inherited, why?

问题描述

我在PHP中有两个类：Figure和Circle。Circle扩展Figure。Figure有一个方法draw()。Circle继承并重写此方法。

draw()方法在父类中被注释，但它在Circle类中没有注释，因为它将继承它。

/**
 * Description of Figure  
 *
 * @author admin
 */
class Figure{

    /**
     * Does something
     */
    public function draw() {

    }
}

/**
 * Description of Circle  
 *
 * @author admin
 */
class Circle extends Figure{


    public function draw() {
        //overriden method
    }
}

多尔沃说： "警告：未记录类Circle的成员DRAW()(Function)。"

如何让多氧放入继承的注释？

推荐答案

您需要使用@copydoc annotation告诉doxygen从哪里获取文档。

/**
 * Description of Circle  
 *
 * @author admin
 */
class Circle extends Figure {

    /**
     * @copydoc Figure::draw()
     */
    public function draw() {
        //overriden method
    }
}

在下面的文档块@copydoc中，您可以添加更多文档，例如方法被重写的原因。

这篇关于DOORT-被覆盖的方法-注释不是继承的，为什么？的文章就介绍到这了，希望我们推荐的答案对大家有所帮助，也希望大家多多支持IT屋！