phpDocumenter и абстрактные методы

Я использую phpDocumentor

Версия phpDocumentor 2.0.0a10`

и есть несколько классов abstract, которые я документирую. Похоже, что документация включает эти abstract classes, но не методы, являющиеся abstract. Обычно я подробно документирую абстрактные методы, чтобы объяснить контракт и свое видение того, как он будет реализован в различных вариантах использования. Есть ли параметр, которого мне не хватает в phpdoc, который заставит его документировать это?


php phpdoc
person wmarbut    schedule 24.08.2012    source источник
comment
@sixeightzero PHP 5.3.13, хотелось бы перейти на 5.4, некоторые из наших устаревших кодов ломаются :(   -  person wmarbut    schedule 24.08.2012

Ответы (1)


arrow_upward
0
arrow_downward

Вот как может выглядеть ваш абстрактный класс с правильным блоком документов.

/**
* login method
*
* Abstract method that must be implemented when
* sub-classing this class.
*
* @access public
* @return boolean
*/
abstract public function login($user, $password);
person au_stan    schedule 15.01.2014
comment
Спасибо. К сожалению, проблема заключалась в том, что phpDocumentor не включал документацию, которую я написал, а не в том, что я не знал, как документировать. - person wmarbut; 15.01.2014