PhpDocumentor как избежать * перед каждой новой строкой комментария

Согласно PhpDocumntor, каждый блок комментариев для преобразования в действительную часть документации должен быть инкапсулирован следующим образом:

/**
* This function is used blah, blah, blah
* line 2
* line 2
* ...
*/
function MyFunc($string) {...

Знаете ли вы, возможно ли (возможно, изменив некоторые настройки) избежать принудительного размещения звездочки перед каждой строкой. Я бы хотел, чтобы PhpDocumentor принимал и преобразовывал в документацию такие комментарии:

/**
This function is used blah, blah, blah
line 2
line 2
...
*/
function MyFunc($string) {...

Я спрашиваю, потому что JsDOC и JavaDoc больше не требуют чертовой звездочки перед каждой новой строкой, поэтому я подумал, что, может быть, PhpDocumentor может сделать это, немного обманув его настройки, но я могу' ничего не нашел об этом в гугле.


php documentation phpdoc
person Marco Demaio    schedule 09.09.2010    source источник
comment
Я не знаю, вы говорите об изменении работы парсера phpDoc. Для этого может быть опция флага, но вам просто нужно посмотреть их документацию. Моя IDE — Zend Studio, и она автоматически вставляет звездочки, так что я не беспокоюсь об этом.   -  person Peter Bailey    schedule 09.09.2010

Ответы (3)


arrow_upward
1
arrow_downward

Возможно, вам следует использовать редактор, который расставляет звездочки за вас, чтобы вам не приходилось делать это вручную. Это делают почти все PHP-совместимые IDE, как и многие программные редакторы с поддержкой PHP.

Использование такой звездочки является стандартным соглашением. Если ваш код не будет спрятан в пещере под тонной цемента, где его никто никогда не увидит, возможно, стоит следовать стандартным соглашениям.

person Jani Hartikainen    schedule 09.09.2010
comment
Как объясняется в вопросе, JsDOC и JavaDoc больше не заставляют звездочку. Так что это не такой уж эталон! Я вижу в этом новую функцию, которая дает кодировщику возможность решить, хочет ли он использовать звездочку в каждой строке или нет. - person Marco Demaio; 12.09.2010
comment
Это согласованный сообществом стандарт PHP. pear.php.net/manual/en/standards.sample.php framework.zend.com/manual/en/coding-standard .coding-style.html - person Jani Hartikainen; 13.09.2010

arrow_upward
0
arrow_downward

Вы должны помнить, что если вы измените способ, которым PhpDoc создает документацию/информацию автозаполнения, конечный пользователь также должен будет изменить свои настройки, если он захочет просмотреть ваш код с документацией/информацией автозаполнения.

Я не знаю об этой опции в PhpDoc, однако вы можете попробовать поиграть с шаблонами DocBlock.

Вот ссылка на воспроизведение с шаблонами блоков документов.

person Bot    schedule 09.09.2010

arrow_upward
0
arrow_downward

Невозможно сделать это с помощью PhpDocumentor.

Я отказался от PhpDocumentor и начал использовать Doxygen. Для всех, кому это может быть интересно, Doxygen позволяет конечному пользователю документировать функции PHP многими способами, среди которых также например, JavaDoc и JsDoc. И вы НЕ обязаны ставить «чертову» звездочку в начале каждой строки в документации, поэтому следующие комментарии допустимы и будут правильно проанализированы Doxygen:

/**
... line1 ...
... line2 ...
*/
function MyFunc($string) {...
person Marco Demaio    schedule 13.09.2010