如何使用phpdoc记录设置方法

我有一个类，它的方法是

getSetting（$name）

和

setSetting（$name，$value）

。这些方法用于在整个类中设置多个设置

我的问题是在

phpDoc

中记录可用设置的最佳方式是什么。我认为，在这些方法之上我无法做到这一点，因为这些方法只在父类中定义，子类可能有自己的设置

我的第一个猜测是将其记录在描述中的每个类之上，如下所示：

<?php
/**
 * A tomato class. Needed for pizza
 * 
 * Settings:
 * color string default: red
 * size integer
 */
 class tomato extends fruit{
    function __construct(){
        $this->setSetting('color','red');
    }
 }

 /**
 * A fruit class
 *
 * Settings:
 * price integer
 */

 class fruit{
    var $settings   = array();
    /**
     * Sets setting
     * @param string $name
     * @param mixed $value
     */
    function setSetting($name,$value = NULL){
        $this->settings[$name]  = $value;
    }

    /**
     * Returns setting
     * @param string $name
     * @return mixed
     */
    function getSetting($name){
        if(isset($this->settings[$name])){
            return $this->settings[$name];
        }else{
            return NULL;
        }
    }
 }


 ?>

---

我想知道这是否正确，或者是否有可用于此的标记，或者可能有其他更好的解决方案。

首先，正如我所看到的，红色是字符串，而不是int:），但无论如何，如果您有一个

private$color

，请定义它，并将php文档添加到其中。如果它是继承的，那么就不重要了，因为当您创建php文档时，它会显示什么是父类。是的，这就是为什么我将字符串放在颜色之后，大小是另一个设置。我没有私有$color，因为它将存储在一个数组中。我知道如何记录VAR，但这里不是这样。