Документация на проекта с помощта на phpdocumentor - развитие и усъвършенстване сайтове - PHP

Документация на проекта с помощта на phpDocumentor

Изисква PHP 5.3.3+.

Задайте разширение на PHP-Intl (интернационализация) и графика рисунка софтуер за Graphviz (командата за Ubuntu / Mint).

инсталация пакет PhpDocumentor с помощта на композитора.

Могат да се зададат на PEAR (временно си поставя круша). Ако не е инсталиран, стартирайте инсталационният с -Z на опцията. Изчерпване на корена, както добре.

Или просто да изтеглите Фар тук.

И сега се освободи phpDocumentor, например, на стандартна инсталация ocStore 1.5.5.1. Имайте предвид, че можете да използвате своя завършен проект. OcStore ние инсталира в директорията / Начало / потребител / public_html / ocstore, където потребител - потребителско име и документацията ще се придържа към същите, в директорията на документи (ако няма, phpDocumentor го създадем себе си). Дълъг процес, имам го отне повече от половин час.

Не е тайна, че OpenCart / ocStore не са документирани по никакъв начин. Въпреки това, ние видите списък на всички класове, и ако кликнете върху диаграма Sharts / йерархията на класовете в горния десен ъгъл, можем да дори клас йерархия в графичен вид да съзерцава (и кошмарен спектакъл е абсолютно безполезен в този случай).

Въпреки това, той е по-добре от нищо. Кликвайки върху всеки един клас, например, ControllerCatalogCategory, можете да получите информация за всички методи и свойства на този клас, както и (в дясно), където файлът е този клас и неговата йерархия.

Тук използваме @var маркер. определяне на вида на класа на собственост.

Сега документира метод, например, getCategories () (това е мястото, където са там без документи параметри).

Тук сме използвали тагове @param и @return. Първият параметър описва метод (за тип), а вторият - стойността на връщане

Рестартирайте процеса на създаване на документация (за пореден път ще отбележа, че този процес е много дълъг).

Ние актуализира ControllerCatalogCategory страница клас и да видите, че има много интересни неща.

Първо, имаше описание на класа. и на първа линия на устройството за скачване е подзаглавието в курсив.

На второ място, описание на вида и свойствата на един клас.

И накрая, ние сме вече добре документирани getCategories () метод.

В процеса на създаване на документация, ние получаваме много предупреждения. Тя phpDocumentor ни предупреждава за всички без документи класове, методи и свойства. Това ни струва цялото си документ - и phpDocumentor почивка. Цели документ ocStore не го правим, но превърне в навик този начин документиране на всеки проект не може да навреди.

Отделно се съсредоточи върху превенцията "Не е намерено обобщение за този файл". Факт е, че, въпреки че тази практика не се насърчава по принцип един файл може да има повече от един клас. Затова phpDocumentor изисква в началото на отделна докинг единица файла за целия файл. По принцип е възможно да се vtulit някаква информация, лиценз, например. С @license на маркер.