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

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

Answer 1

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

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

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

Answer 2

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

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

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

Answer 3

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

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