Как документировать константы класса для phpDoc? Я прочитал руководство, но я ничего не могу найти о них.
Документация по константам класса phpDoc
Ответ 1
Я вполне уверен, что вы можете использовать @const
, хотя я не могу найти никакой документации на английском языке. Там немецкий пример здесь. Он показывает define
операторов, а не константы класса, но IIRC синтаксис тот же.
Девять лет спустя редактирование...
Теперь ясно, что вышесказанное - плохой совет, так как @const
не появился в документации и, похоже, не появится.
Использование @var
кажется, работает, хотя я нигде не вижу его явно указанного.
Ответ 2
Константам нужен только док-блок, содержащий описание. Никакой специфический тег не нужен. Сам анализатор кода идентифицирует константы и отображает их как таковые в сгенерированной документации (здесь пример).