Pripravený na použitie
Stiahnite generátor s predvolenými nastaveniami. Nahrajte ho na PHP server a nastavte zdrojové priečinky.
Stiahnuť generátor ↓
4ASuite / Nástroje pre vývojárov
Váš PHP kód.
phpDG · GENERÁTOR PHP DOKUMENTÁCIE
Váš PHP kód.
Prehľadne zdokumentovaný.
Premeňte triedy, metódy a DocBlocky na prehľadnú dokumentáciu. Stačí vám jediný PHP súbor.
Otvorený kód · Licencia MIT · Bez Composeru
phpDG / dokumentácia
VÁŠ KÓD
/**
* Find a user by their ID.
* @param int $id
* @return User|null
*/
public function find(int $id): ?UserVAŠA DOKUMENTÁCIA
UserRepository Trieda
find(int $id): ?UserNájde používateľa podľa ID.
1PHP súbor
0závislostí
10jazykov
MITzadarmo a s otvoreným kódom
ZAČÍNAME
Malý súbor. Užitočný pomocník.
Začnite s predvolenými nastaveniami alebo pripravte generátor pre svoj projekt.
Prispôsobte si ho
Pred stiahnutím vyberte zdrojové priečinky, výstupný adresár, jazyky a voliteľné HTTP overenie.
Preskúmajte zdrojový kód
Prezrite si kód, sledujte vývoj alebo prispejte vylepšením na GitHube.
Pozrieť na GitHube ↗PRE KAŽDODENNÝ VÝVOJ
Menej nastavovania. Viac porozumenia.
Jeden súbor, žiadne závislosti
Nahrajte generátor bez správcu balíkov a zostavovania projektu.
Prehľadná štruktúra projektu
Prezerajte triedy, metódy a funkcie v stromovej navigácii.
Vyhľadávanie počas písania
Nájdite požadovanú časť kódu vo vygenerovanej dokumentácii.
Podpora DocBlockov
Uchovajte popisy, parametre a návratové hodnoty spolu s kódom.
Váš jazyk, vaša voľba
Vyberte si z desiatich jazykov dokumentácie vrátane slovenčiny a češtiny.
Voliteľná ochrana prístupu
Pri príprave tímovej dokumentácie nastavte HTTP používateľov.
DOKUMENTÁCIA
Od kódu k dokumentácii v troch krokoch.
Nahrajte generátor
Umiestnite generator.php na PHP server, kde bude mať prístup k súborom projektu.
Vyberte priečinky
Použite konfigurátor alebo upravte pole nastavení na začiatku stiahnutého súboru.
Vygenerujte a prezerajte
Otvorte generátor v prehliadači, vygenerujte dokumentáciu a potom otvorte output/index.html.
Príklad konfigurácie
$settings = [
'directories' => ['./src', './app'],
'output_dir' => 'output',
'exclude_dirs' => ['vendor', 'cache'],
'http_auth' => [],
'language' => 'en',
'available_languages' => ['en', 'sk', 'cs'],
];ŽIVÉ DEMO
Pozrite sa, ako môže vyzerať vaša dokumentácia.
Vyskúšajte generátor
Otvorte online demo phpDG a preskúmajte rozhranie generátora.
Spustiť generátor ↗Prezrite si vygenerovanú dokumentáciu
Preskúmajte reálny príklad s navigáciou projektu, triedami a metódami.
Pozrieť dokumentáciu ↗ZADARMO A S OTVORENÝM KÓDOM
Používajte ho. Stavajte na ňom.
phpDG je dostupný pod licenciou MIT pre osobné aj komerčné projekty.
Kód a licencia ↗