Doxygen - 重写方法 - 评论不是继承的,为什么?

时间:2016-05-04 09:54:22

标签: php doxygen

我在PHP中有两个类:FigureCircleCircle延伸FigureFigure有一个方法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
    }
}

Doxygen说: "警告:没有记录Circle类的成员draw()(函数)。"

如何将Doxygen置于继承评论中?

1 个答案:

答案 0 :(得分:0)

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

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

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

@copydoc下面的文档块中,您可以添加更多文档,例如为什么方法被覆盖。