Pomocí speciálních komentářů vygenerujeme programátorskou příručku.
Dnešní poslední díl bude poněkud kratší, nicméně velmi důležitý. Dneska se podíváme na to nejdůležitější a to samotné vygenerování naší příručky. V minulých dílech jsme si ukázali, jaké má phpDocumentor výhody a základní tagy pro popis. Pojďme tedy dokumentaci vygenerovat.Ze všeho nejdříve je třeba stáhnout PHPDocumentor a to provedete zde. Balíček rozbalíme. Jelikož je PHPDocumentor psaný v php, potřebujeme jej pustit přes nějaký web server. Pod Windows je dobrá kombinace Apache, PHP , MySQL v jedné instalaci ->EasyPHP. Databázi pro dokumentaci nepotřebujeme. Popis instalace EasyPHP zde popisovat nebudu.
Počítám, že nyní máte vše potřebné nainstalováno a můžeme otevřít PHPDocumentor v prohlížeči. Nyní už nás dělí od cíle pár jednoduchých kroků. Na úvodní stránce se nachází popis toho, co PHPDocumentor umí. Můžeme klidně preskočit a to rovnou na položku Files. Zde máme 4 položky. Vkládáme hodnoty oddělené stránkou.
1. Files to parse – soubory, které chceme převést
2. Directory to parse – asi nejdůležitější - adresáře, které chceme převést (nejjednodušší je zadat zde nadřazený adresář projektu a ostatní nevyplňovat)
3. Files to ignore – soubory, které chceme vynechat (pokud soubory neobsahují žádné tagy, jsou automaticky vynechány)
4. Packages to parse– balíčky, které chceme převést
Dále je třeba nastavit výstup a to v části Output.
1. Target – adresář, kde chceme dokumentaci vygenerovat
2. Output Format– výstupní šablona. V rolovánu vybereme název šablony. Rovnou můžeme vidět náhled. Opět můžeme oddělit šablony čárkou, PHPDocumentor vygeneruje rovnou všechny šablony najednou. POZOR – pdf nezvládá české znaky.
Poslední položka slouží k nastavení pár posledních položek. V menu Options nastavíme:
1. Generated Documentation Title – nadpis dokumentu
2. Default Package Name –název výchozího balíčku
3. Default Category Name–název výchozí kategorie
Toto byl poslední krok, nyní stačí kliknout na create a chvíli počkat.
Autor: Honzy
2024 ©