A PHP-doc - s blog
Írásban dokumentációt a kód - nem a leginkább kellemes és vidám, de ha egy nagy projekt, és / vagy részt vesz a csapat fejlődését, akkor azt mondanám, hogy ez csak a dolog, sőt szükséges. Ha van egy csomó különböző felületek, osztályok, függvények, eljárások különböző parmetrami és kimeneti adatok, és ez a munka több mint egy fejlesztő nagyon jó, hogy van kéznél egy leírást az összes ilyen azonos osztályban, azok jellemzői és paraméterei, de nem fut minden időben a fejlesztő, és megkérdezi, hogy melyik lehetőséget jelent. Ez nem, semmiképpen sem változtat az a tény, hogy már a nevek osztályok, módszerek és paraméterek kell értelmes neveket, de nem most erről beszédet. Most beszélünk dokumentáció a forráskód a php. Azt az erre a célra valamilyen eszköz, például Doxygen.
Mi Doxygen?
Azok számára, akik nem tudják, mi ez, egy rövid áttekintést. Ahogy írva a projekt honlapján:
Doxygen - ez egy cross-platform rendszer dokumentálásának forráskódot, amely támogatja a C / C ++, Objective-C, Python, Java, IDL, PHP, C #, Fortran, VHDL, és részben a D.
Ez a típus alatt az összes jelentős platformok: Windows / Linux / MacOS; és néhány rajongó még átírta Solaris / OS / 2 / IRIX / FreeBSD. Szintén a helyszínen van egy finom dokumentációt pdf-formátumban és CHM-formátumban. Erősen ajánljuk, hogy megnézze.