phpdoc: как правильно документировать константу

Question

Есть ли правильный способ документировать константу, определенную с помощью define()?@var на самом деле не имеет смысла.Единственное, о чем я могу подумать, это опустить тег и просто написать описание в комментарии к PHPdoc.

Answer 1

phpDocumentor не распознает и не использует тег @const. phpDocumentor распознает константу, когда видит ключевое слово «define» в коде. Его выходные шаблоны покажут все константы в выходной документации, перечисленные как константы. Единственное, что необходимо в докоблоке константы, - это описание, хотя допускается множество других «стандартных» тегов, если вы считаете, что они вам нужны [1].

[1] - http://manual.phpdoc.org/HTMLSmartyConverter/HandS/phpDocumentor/tutorial_elements.pkg.html#procedural.define

Answer 2

Вы действительно хотите использовать @type, см. Документацию Github PHP .

Answer 3

Использование @const.

/**
  * @const FOO Bar
  */
define('FOO', 'Bar');

Документация (Извините, я могу найти только документы на немецком языке).