使用phpDocumentor记录PHP常量(定义)的正确方法是什么

时间:2010-02-03 14:50:40

标签: php constants phpdoc

我们如何在PHP中使用phpDocumentor定义(使用define())常量?

我在文档中找不到任何内容,但在sample2.php中找到了以下示例(我没看到它的用法):

/**#@+
 * Constants
 */
/**
 * first constant
 */
define('testing', 6);
/**
 * second constant
 */
define('anotherconstant', strlen('hello'));

任何人都可以告诉我使用phpDocumentor在PHP中记录常量的最佳方法是什么?

3 个答案:

答案 0 :(得分:6)

定义语句通常只用描述性文本进行评论,因此基本上就是如何评论它。

要详细了解DocBlock模板标记/**#@+,请查看the manual page

答案 1 :(得分:1)

/**
*@const
*/
const testing=6;
const anotherconstant=strlen('hello');

试试这个你会看到它为常数

答案 2 :(得分:0)

你有phpDoc.org the elements that can be documented

您还有an example of documenting a define()(第二段代码和周围段落)。