2010-04-29 15 views
8

Ok, sono stufo di phpDocumentator. Consuma molto più memoria (1,4 GB) e tempo (5 minuti su Core 2 Duo a 2,6 GHz) di quanto sono disposto a darlo. Esiste qualche programma veramente compatibile per generare documentazione per il codice PHP?phpDocumentor alternativa che consuma meno memoria

Ho provato PHPDoctor, che sembra bello, ma ha qualche missing features. Tuttavia è probabilmente il più vicino a essere la sostituzione di tutte le soluzioni che ho provato finora.

Ho anche provato PhpDocGen, ma viene visualizzato solo con alcuni errori Perl, che sono troppo pigro per studiare.

Anche Doxygen non sembra funzionare bene con le nostre fonti.

PS: la documentazione è per phpMyAdmin, la documentazione un po 'obsoleta è here.

Aggiornamento: Il codice contiene molte funzioni e non solo oggetti, qual è il problema più grande con Doxygen, perché non riesce a organizzarli.

+2

Per interessi, quanto è intensiva la memoria per il tuo progetto specifico? – Andy

+0

Arresto anomalo con limite di 1 GB e ancora molti file da elaborare. –

+0

mmm. Io seriamente non vedo il problema. non è come si esegue PHPdocumentor 24 ore al giorno. come hai detto tu - è un affare di 5 minuti che fa parte del tuo processo di costruzione. – Stann

risposta

2

Doxygen è piuttosto complesso e supporterà supportare le funzionalità di PHP 5.3. Tuttavia, non ha funzionato esattamente come lo volevo e ho capito che è un grande programma, ma non progettato per PHP; quindi avevo bisogno di qualcosa di più leggero, più semplice e preferibilmente esclusivo di PHP, perché ammettiamolo, PHP non ha la sintassi e il linguaggio del linguaggio di programmazione.

So che l'hai menzionato, ma alla fine ho scelto PHPDoctor. Manca infatti alcune funzionalità, ma è semplice e veloce, esattamente quello che stavo cercando.

Facci sapere cosa hai scelto e quali sono stati i motivi.

Inoltre, ho notato che ho trovato l'interfaccia di PHPDoctor abbastanza semplice e facile da applicare (con alcune modifiche CSS). Sono stato in grado di creare una pagina abbastanza pulita per i miei documenti.

1

ho usato Natural Docs, funziona bene per me

+0

Potrebbe essere una buona opzione, ma significherebbe convertire tutta la documentazione in un nuovo formato, il che è un lavoro che vorrei evitare. –

3

Siamo passati da phpDocumentor al Doxygen perché il primo non ha sostenuto PHP 5.3 caratteristiche come spazi dei nomi e chiusure. L'ultimo aggiornamento di phpDocumentor risale al 2008.

I principali @ sono gli stessi in Doxygen, perché entrambi fanno commenti in stile JavaDoc. È anche abbastanza configurabile.

+0

Vedo diversi problemi con Doxygen, ma forse non riesco proprio a configurarlo correttamente. Non gestisce i commenti a livello di file e crea enormi problemi nella documentazione dello spazio dei nomi.Non genera documentazione per le funzioni a meno che non sia abilitato 'EXTRACT_ALL' e non fornisce ancora un modo semplice per sfogliare le funzioni oltre a passare attraverso i file. Inoltre non supporta @uses e @subpackage. –

+0

Non usiamo '@ subpackage' (questo è ciò che fanno ora gli spazi dei nomi) o' @ uses' (non serve, hah). Per quanto riguarda i commenti a livello di file: questo può effettivamente essere un problema, ma seguiamo l'approccio "una classe per file", quindi usiamo solo commenti di classe. – janmoesen

+0

Avere solo classi renderebbe le cose probabilmente più facili, ma non è il caso (ancora). –

3

Puoi anche provare DocBlox; è un nuovo capretto sul blocco (gioco di parole), ma supporta già molte delle funzionalità fornite da phpDocumentor e molte delle novità (come i namespace). Provalo allo https://www.github.com/mvriel/Docblox

+0

Si focalizza ancora sul codice oggetto e sulle classi ed è praticamente inutile per il codice che contiene principalmente funzioni. Provalo su phpMyAdmin. –

+0

Che tipo di organizzazione hai in mente? Apparentemente ci si aspetta che gli strumenti di generazione della documentazione raggruppino in qualche modo queste funzioni in sezioni logiche. Per classi e file questo viene fatto per classe, spazio dei nomi e il tag @package nel docblock. le funzioni sono comunemente raggruppate a livello di file (che è possibile raggruppare usando il tag @package) –

+0

@Mike van Riel Adoro Docblox. Lo uso con i commenti che ho scritto per PHPDocumentor senza modifiche, ed è fantastico. Qualche interesse nello sviluppo di un'interfaccia HTML? –

Problemi correlati