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

Question

Согласно 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 больше не требуют чертовой звездочки перед каждой новой строкой , поэтому я подумал, что tat может быть, PhpDocumentor может сделать это, немного обманув его настройки, но ничего не могу найти по этому поводу в Google.

Answer 1

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

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

Answer 2

Нет способа сделать это с помощью PhpDocumentor.

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

/**
... line1 ...
... line2 ...
*/
function MyFunc($string) {...  

Answer 3

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

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

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