Как документировать метод настроек с помощью 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;
}
}
}?>

Мне было интересно, если это было правильно, или могут быть теги, доступные для этого, или, возможно, другое лучшее решение.

0

Решение

Задача ещё не решена.

Другие решения

Других решений пока нет …

По вопросам рекламы [email protected]