Список записей с тегом: documentation

Yii2. Пример документирования API с помощью Swagger

Yii2 и Swagger. Автогенерируемая документация в Yii2 с помощью Swagger на основе аннотаций в коде.

Yii 2, псевдонимы пути для приложений basic и advanced

Псевдонимы (алиасы) предназначены для обозначения путей к папкам, файлам или URL. Псевдонимы помогают избежать использования абсолютных путей или URL в коде. Чтобы не путать псевдоним с обычным путем к папке, файлу или URL, он должен начинаться с @. В yii есть заранее заданные псевдонимы (алиасы), например @yii, @app, но так же есть возможность задать свои псевдонимы.

PhpDocumentor установка на Windows и создание документации

PHPDocumentor - это инструмент, который позволяет генерировать документацию непосредственно из исходного кода PHP.

PhpDocumentor автоматически генерирует из исходного кода документацию, поэтому для получения качественноей документации Вам необходимо правильно построить комментарии с помощью docblock-ов (подробно о Документирование кода PHP на основе DocBlock комментариев).

Инструкция по установке PhpDocumentor несколькими способами и дальнейшем его использовании

Документирование кода PHP на основе DocBlock комментариев

Хорошие комментарии позволяют упростить читаемость и дальнейшее сопровождение кода. А при написании комментариев с учетом стандарта DocBlock Вы получите возможность автоматически генерировать документацию и ускорить написание нового кода при помощи подсказок IDE выводимых на основе этих комментариев