ApiGen - generování dokumentace pro PHP kód Funguje ve webovém prohlížeči

Logo ApiGen

Velikostí menší, ale funkcemi propracovaný script pro generování dokumentace s vyhledáváním pro zdrojové kódy napsané ve scriptovacím jazyce PHP.

ApiGen je nenápadný, ale o to zajímavější řešení pro generování dokumentace při programování  webových projektů v jazyce PHP.

Použití programu vyžaduje zdrojový kód systematicky a důsledně komentovat s použitím tzv. DocBlock komentářového stylu (využívá se u PHP). Za pomocí elementů jako je např. @param integer $pocet cislo reprezentujici pocet neceho, dokumentační skript vygeneruje přehled, který je přehlednější než původní zdrojový kód. Navíc veškeré třídy, jejich proměnné a hodnoty, které vrací jsou uloženy v jednom dokumentu.

ApiGen přináší:

  • skript pro generování dokumentace z PHP kódu opatřeného DocBlock komentáři
  • napsaný je sám v jazyce PHP - spouštět se musí z příkazové řádky Linuxu, Windows či dalšího operačního systému na které může běžet PHP interpreter
  • výsledkem je soubor HTML stránek s přehledem tříd a metod tříd, proměnných, který vyžadují a hodnot, které vracejí
  • umožňuje vyhledávat dle názvu třídy

ApiGen nedisponuje téměř žádnou dokumentací, ale všechny potřebné informace k používání lze zobrazit po zadání příkazu "apigen generate --help"

Přehled PHP třídy ve vygenerované dokumentaci pomocí ApiGen
Zobrazení zdrojového kódu se zvýrazněním syntaxePřehled dokumentovaných tříd

Stáhnout ApiGen (1,3 MB) - Není závislý na OS


12345 (5 = nejlepší) Ohodnoťte ApiGen
Líbí se vám ApiGen? :
Operační systém: Není závislý na OS
Jazyk: Anglický
Instaluje se: Ne

Kód pro sdílení článku: (zobrazit »)

Odkaz:

HTML kód:

Kód do fóra:

Počet komentářů: 0 | Přidat komentář |
|
Informační e-mailDoporučit článek kamarádovi / kamarádce (e-mailem)

MP3: Vivaldi , Jaromír Nohavica MP3
Programy: AVG zdarma , avast! Free Antivirus , OpenOffice.org , online ICQ , Verdict Free anglicko český slovník , CCleaner, KMPlayer
Video: Vyprávěj , iVysílání
Ostatní: SMS zdarma do všech sítí , Seriály online , CCCP kompletní video kodeky , Online disk Dropbox s 500 MB bonusem.