代码之家 › 专栏 › 技术社区 › Marco Demaio

PhpDocumentor如何避免在每个新的注释行前面出现*

phpdoc documentation php

2

Marco Demaio · 技术社区 · 16 年前

根据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上找不到任何关于这个的东西。

3 回复 | 直到 16 年前

1

Jani Hartikainen 16 年前

也许你应该使用一个编辑器来为你放置星号,这样你就不必手动操作了。几乎所有与PHP兼容的ide都能做到这一点,许多支持PHP的程序员编辑器也是如此。

2

0

Bot 16 年前

我不知道这个选项在PhpDoc但是你可以尝试玩DocBlock模板。

这是一个 link

3

0

Marco Demaio 16 年前

我放弃了PhpDocumentor开始 使用强氧剂 . 对于任何可能感兴趣的人来说,Doxygen允许最终用户以多种方式记录PHP函数,其中包括 比如JavaDoc和JsDoc . 而且您不必在文档中的每一行的开头都加上一个“该死的”星号,因此以下注释是可以的,将由Doxygen正确解析:

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