Документация по константам класса phpDoc

Question

Как мне документировать константы класса для phpDoc? Я прочитал руководство, но ничего не могу найти о них.

Answer 1

Я уверен, что вы можете использовать @const Хотя я не могу найти документацию на английском языке. Здесь есть немецкий пример. Это показывает define операторы, а не константы класса, но IIRC синтаксис тот же.

Answer 2

Константы нужны только в докоблоке, который содержит описание. Никаких конкретных тегов не требуется. Сам анализатор кода идентифицирует константы и отображает их как таковые в сгенерированной документации ( вот пример).

Answer 3

Полный список всех тегов PHPDoc 3: Справочник по тегам

В инструкции сказано следующее:

@вар

Вы можете использовать тег @var для документирования типа следующих структурных элементов:

• Константы, как класса, так и глобальной области видимости
• Характеристики
• Переменные, как глобального, так и локального масштаба