2

根据 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 上找不到任何相关信息.

4

3 回答 3

1

也许您应该使用为您放置星号的编辑器,因此您不必手动进行。几乎所有与 PHP 兼容的 IDE 都这样做,许多支持 PHP 的程序员编辑器也是如此。

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

于 2010-09-09T19:36:52.020 回答
0

使用 PhpDocumentor 无法做到这一点。

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

/**
... line1 ...
... line2 ...
*/
function MyFunc($string) {...  
于 2010-09-13T16:07:37.633 回答
0

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

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

这是一个使用 doc 块模板的链接。

于 2010-09-09T18:07:16.537 回答