Как правильно документировать константы PHP (определить) с помощью phpDocumentor

Question

Как мы должны документировать (с phpDocumentor ) константы, определенные с помощью define () в PHP?

Я ничего не нашел в документации, но нашел следующий пример (который я не вижу его использования) в sample2.php:

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

Кто-нибудь может сказать мне, как лучше всего документировать константы в PHP с помощью phpDocumentor?

Answer 1

Определить операторы, как правило, только комментируют с описательным текстом, так что это в основном, как вы это комментируете.

Чтобы узнать больше о теге шаблона DocBlock, /**#@+, ознакомьтесь с страницей справочника .

Answer 2

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

Попробуйте, вы увидите это как постоянное

Answer 3

У вас есть на phpDoc.org элементы, которые можно задокументировать .

У вас также есть пример документирования define () (второй фрагмент кода и окружающие его абзацы).