抽象类中PHP方法的文档


Documentation of PHP methods in the abstract class

是否可以在抽象方法上制作方法文档,以及在文档中扩展它的人?示例:

<?php
abstract class Math{
    /**
     * Method that receive two values and return the result of some operation.
     * @param $a Number
     * @param $b Number
     */
    abstract public function values($a, $b);
}
?>
<?php
class Sum extends Math{
    /**
     * @return $a+$b;
     */
    public function values($a, $b){
        return $a+$b;
    }
}
?>
<?php
class Divide extends Math{
    /**
     * @return $a/$b;
     * @throws Exception.
     */
    public function values($a, $b){
        if($b != 0){
            return $a/$b;
        }else{
            throw new Exception("Impossible to divide by 0.");
        }
    }
}
?>

我该如何把所有关于这个方法的信息放在一起?目前,我使用Netbeans 7.1。这是IDE的问题吗?或者这不是怎么回事?

<?php
// Estabele conexão com o MySQL
$connect = mysql_connect('localhost', 'root', '123456') or die('A conexão falhou.');
// Seleciona o banco de dados
$database = mysql_select_db('monografia', $connect) or die('Falha ao tentar selecionar banco de dados.');
if ($database)
    echo 'Conectado atraves do driver nativo.';
?>
<br />
<?php
class Conexao {
    protected $conexao;
    public function Conexao() {
        $this->conexao = new MySQLi('localhost', 'root', '123456', 'monografia', 3306);
        if (!$this->conexao->connect_error)
            echo 'Conectado atraves da extensao MySQLi.';
    }
}
new Conexao();
?>
<br />
<?php
class ConexaoPDO {
    protected $pdo;    
    public function ConexaoPDO() {
        try {
            $this->pdo = new PDO('mysql:host=localhost:3306;dbname=monografia', 'root', '123456', array(PDO::ATTR_ERRMODE => PDO::ERRMODE_EXCEPTION));
            echo 'Conectado atraves do PDO.';
        } catch(PDOException $e) {
            echo $e->getMessage();
        }
    }
}
new ConexaoPDO();
?>

这将特定于所使用的工具/ide/插件。就常见做法而言,我从未见过继承的文档。在任何情况下,只要想一想,如果你为每个类(继承的、抽象的或其他的)放入完整的文档,对其他阅读你的代码的人来说,清晰度会有多好。

我建议您查看@inheritDoc标记。