php - Doxygen - 重写方法 - 注释不被继承，为什么？

Question

我在 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()(函数)。”

如何让Doxygen放入继承的注释中？

Answer 1

你需要告诉 doxygen 从哪里获取文档，使用 @copydoc annotation .

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

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

在 @copydoc 下方的文档 block 中，您可以添加更多文档，例如为什么重写该方法。