Есть ли способ документировать константу, определенную с помощью define()
? @var на самом деле не имеет смысла. Единственное, о чем я могу думать, это опустить тег и просто написать описание в комментарии PHPdoc.
phpDocumentor не распознает или не использует тег @const. phpDocumentor распознает константу, когда видит ключевое слово «define» в коде. Его выходные шаблоны будут отображать все константы в выходной документации, перечисленные как константы. Единственное, что требуется в docblock константы, – это описание, хотя многие другие «стандартные» теги разрешены, если вы чувствуете, что вам это нужно [1].
Используйте @const
.
/** * @const FOO Bar */ define('FOO', 'Bar');
Документация (Извините, единственные документы, которые я могу найти, находятся на немецком языке).
Вы действительно хотите использовать @type
, см. Документацию Github PHP .