4ASuite / Nástroje pro vývojáře

phpDG · GENERÁTOR PHP DOKUMENTACE

Váš PHP kód.
Přehledně zdokumentovaný.

Proměňte třídy, metody a DocBlocky v přehlednou dokumentaci. Stačí vám jediný PHP soubor.

Otevřený kód · Licence MIT · Bez Composeru

phpDG / dokumentace
VÁŠ KÓD
/**
 * Find a user by their ID.
 * @param int $id
 * @return User|null
 */
public function find(int $id): ?User
VAŠE DOKUMENTACE

UserRepository Třída


find(int $id): ?User

Najde uživatele podle ID.

ParametryNávratové hodnotyZdroj
1PHP soubor
0závislostí
10jazyků
MITzdarma a s otevřeným kódem

ZAČÍNÁME

Malý soubor. Užitečný pomocník.

Začněte s výchozím nastavením nebo připravte generátor pro svůj projekt.

01 / STAŽENÍ

Připravený k použití

Stáhněte generátor s výchozím nastavením. Nahrajte ho na PHP server a nastavte zdrojové složky.

Stáhnout generátor ↓
03 / SPOLUPRÁCE

Prozkoumejte zdrojový kód

Prohlédněte si kód, sledujte vývoj nebo přispějte vylepšením na GitHubu.

Prohlédnout na GitHubu ↗

PRO KAŽDODENNÍ VÝVOJ

Méně nastavování. Více porozumění.

Jeden soubor, žádné závislosti

Nahrajte generátor bez správce balíčků a sestavování projektu.

Přehledná struktura projektu

Prohlížejte třídy, metody a funkce ve stromové navigaci.

Vyhledávání při psaní

Najděte požadovanou část kódu ve vygenerované dokumentaci.

Podpora DocBlocků

Uchovejte popisy, parametry a návratové hodnoty spolu s kódem.

Váš jazyk, vaše volba

Vyberte si z deseti jazyků dokumentace včetně slovenštiny a češtiny.

Volitelná ochrana přístupu

Při přípravě týmové dokumentace nastavte HTTP uživatele.

DOKUMENTACE

Od kódu k dokumentaci ve třech krocích.

01

Nahrajte generátor

Umístěte generator.php na PHP server, kde bude mít přístup k souborům projektu.

02

Vyberte složky

Použijte konfigurátor nebo upravte pole nastavení na začátku staženého souboru.

03

Vygenerujte a prohlížejte

Otevřete generátor v prohlížeči, vygenerujte dokumentaci a poté otevřete output/index.html.

Příklad konfigurace
$settings = [
    'directories' => ['./src', './app'],
    'output_dir' => 'output',
    'exclude_dirs' => ['vendor', 'cache'],
    'http_auth' => [],
    'language' => 'en',
    'available_languages' => ['en', 'sk', 'cs'],
];

ŽIVÉ DEMO

Podívejte se, jak může vypadat vaše dokumentace.

Vyzkoušejte generátor

Otevřete online demo phpDG a prozkoumejte rozhraní generátoru.

Spustit generátor ↗

Prohlédněte si vygenerovanou dokumentaci

Prozkoumejte skutečný příklad s navigací projektu, třídami a metodami.

Prohlédnout dokumentaci ↗

ZDARMA A S OTEVŘENÝM KÓDEM

Používejte ho. Stavte na něm.

phpDG je dostupný pod licencí MIT pro osobní i komerční projekty.

Kód a licence ↗
Získat phpDG ↓