Contratto modulo
- Chiave
- documentazione
- Rotta
- modules/documentazione
- Legacy
- documentazione tecnica assente nel legacy
- Gruppo
- strumenti
Modulo strumenti
▤ Documentazione
Documentazione tecnica generabile con phpDocumentor senza appesantire il runtime dell’applicazione.
Portali abilitati
standard, custom
Campi previsti
Pagina modulo
Pannelli funzionali
Scelta tecnica
phpDocumentor viene predisposto come generatore opzionale: l’applicazione continua a funzionare anche se il tool non è installato.
Percorsi
Il file di configurazione è phpdoc.dist.xml, l’output previsto è docs/api e la cache resta in storage/phpdoc/cache.
Regola sana
La documentazione si genera con comando esplicito, non durante la navigazione utenti e non durante i moduli AJAX.
Anteprima
Contratto phpDocumentor
| Voce | Valore | Nota |
|---|---|---|
| Config | phpdoc.dist.xml | Versionabile |
| Output | docs/api | Generato a comando |
| Cache | storage/phpdoc/cache | Fuori dalla UI |
| Sorgenti | app, routes, index | Solo codice progetto |
Dati dimostrativi: servono solo a verificare layout, AJAX e contratto UI.