Как мы должны документировать (с phpDocumentor ) константы, определенные с помощью define () в PHP?
Я ничего не нашел в документах, но нашел следующий пример (который я не вижу его использование) в sample2.php:
/**#@+ * Constants */ /** * first constant */ define('testing', 6); /** * second constant */ define('anotherconstant', strlen('hello')); Кто-нибудь может сказать мне, что лучший способ документировать константы в PHP с помощью phpDocumentor?
Определить утверждения, как правило, только прокомментированы с описательным текстом, так что это в основном, как вы его комментируете.
Чтобы узнать больше о теге шаблона DocBlock, /**#@+ , просмотрите страницу руководства .
/** *@const */ const testing=6; const anotherconstant=strlen('hello');
Попробуйте это, вы увидите его как постоянный
У вас есть на phpDoc.org элементы, которые могут быть задокументированы .
У вас также есть пример документирования define () (вторая часть кода и окружающие абзацы).