开发者

What is the correct way to document PHP constants (define) with phpDocumentor

开发者 https://www.devze.com 2022-12-18 19:19 出处:网络
How must we document (with phpDocumentor) constants defined with define() in PHP? I found nothing in the docs, but found the following example (which I don\'t see it\'s use) in the sample2.php:

How must we document (with phpDocumentor) constants defined with define() in PHP?

I found nothing in the docs, but found the following example (which I don't see it's use) in the sample2.php:

/**#@+
 * Constants
 */
/**
 * first开发者_JAVA技巧 constant
 */
define('testing', 6);
/**
 * second constant
 */
define('anotherconstant', strlen('hello'));

Anyone can tell me what's the best way to document constants in PHP with phpDocumentor?


Define statements are in general only commented with a descriptive text, so that's basically how you comment it.

To read more about the DocBlock template tag, /**#@+, check out the manual page.


You have at phpDoc.org the elements that can be documented.

You also have an example of documenting a define() (the second piece of code and surrounding paragraphs).


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

Try this you will See it As Constant

0

精彩评论

暂无评论...
验证码 换一张
取 消