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

也许您应该使用一个为您设置星号的编辑器，因此您不必手动执行此操作。几乎所有与PHP兼容的IDE都可以做到这一点，许多程序员的编辑都支持PHP。

使用这样的星号是标准惯例。除非你的代码被隐藏在一个洞穴中，在没有人会看到它的大量水泥下，否则遵循标准惯例可能是一个好主意。

Answer 2

您必须记住，如果您更改PhpDoc创建文档/自动完成信息的方式，最终用户还需要更改其设置，以便他们希望使用文档/自动完成信息查看您的代码。

我不知道PhpDoc中的这个选项，但您可以尝试使用DocBlock模板。

以下是使用doc块模板的link。

Answer 3

使用PhpDocumentor无法做到这一点。

我放弃了PhpDocumentor并开始使用Doxygen 。对于任何可能感兴趣的人，Doxygen允许最终用户以多种方式记录PHP功能，其中如JavaDoc和JsDoc 。并且您不必在文档中的每一行的开头放置一个“该死的”星号，因此以下注释是可以的，并且将由Doxygen正确解析：

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