Raccomandazioni per chi sta considerando phpDocumentor:
Ho avuto esperienza sia con Swagger che con PHPDoc. Swagger è complesso e richiede molto tempo per scrivere documenti. PHPDoc offre solo un modo semplice per scrivere documenti nel mezzo del codice. Se stai scegliendo tra i due, probabilmente suggerirei PHPDoc. L'unica caratteristica mancante di PHPDoc è la mancanza di supporto per array tipizzati annidati così come per array chiave-valore. Recensione raccolta e ospitata su G2.com.
Quali problemi sta risolvendo phpDocumentor e come ti sta beneficiando?
I documentatori del codice sorgente risolvono due problemi principali: "Consegna del codice sorgente" e "Riferimento API".
I due strumenti di documentazione ben noti per PHP sono PHPDoc e Swagger.
Swagger fornisce una soluzione più complessa per documentare il codice PHP. Puoi incorporare la sintassi nel mezzo del codice o semplicemente creare file separati per la documentazione. Le classi devono essere mappate indipendentemente, il che rende più dispendioso in termini di tempo scrivere un documento. Anche la sintassi incorporata è difficile da scrivere.
D'altra parte, l'unica cosa che devi fare con PHPDoc è scrivere il tuo documento sopra le tue definizioni. La sintassi è pulita, ha supporto nativo da parte degli IDE popolari, inclusi PHPStorm, Netbeans, ecc. e complessivamente tutto si muove molto facilmente. Recensione raccolta e ospitata su G2.com.