Ciao ragazzi!!
siete a conoscenza di un tool per documentare gli script php?
Un tool in grado di aprire un file, raccogliere tutte le funzioni e le classi con i vari metodi, e permettere di creare della documentazione a partire da php?
come sempre
Grazie!!
Lungo le due rive del fiume gelato si stendeva la cupa e tetra foresta di abeti, dai quali il vento aveva appena spazzato il manto di brina. Nella luce crepuscolare quegli abeti neri e sinistri sembravano inclinarsi l'uno verso l'altro. Un silenzio minaccioso incombeva sul paesaggio, privo di qualsiasi segno di vita o di movimento, e desolato e freddo al punto da non poter ispirare che un solo sentimento: quello della più triste malinconia. E nello stesso tempo pareva che da quel paesaggio trapelasse una specie di riso, un riso ben più spaventoso di qualsiasi malinconia o tristezza, un riso tragico, come quello di una sfinge, un riso agghiacciante più della brina e che rammendava l'incombere minaccioso dell'ineluttabile. Era la saggezza potente e impenetrabile dell'eternità che irrideva alla vita, alla sua futilità e agli sforzi degli uomini.
![L'avatar di }gu|do[z]{®©](image.php?u=17713&dateline=1210448886 "L'avatar di }gu|do[z]{®©")
una cosa tipo javadoc, ma per php???
Se non erro c'era un tool simile in qualche editor, ma non ricordo quale.. forse phpEdit...
ma penso se ne possano trovare tanti, infondo non è una cosa difficile d arealizzare... volendo te la puoi afre nche casareccia cn php steesso
http://www.phpdoc.org/Originariamente inviato da }gu|do[z]{®©
una cosa tipo javadoc, ma per php???
Avevo visto phpdoc.org, ho letto anche il tutorial ma non è quello che cercavo
Mi spiego meglio. Io ho sempre detestato (ma sicuramente sono io ad essere malato) la documentazione creata tramite i sorgenti, vedi javadoc.
Mi chiedevo se esiste qualcosa di più carino - aka più adatto alle mie esigenze - per evitare di sviluppare un clone.
Mi piacerebbe un programma di documentazione in grado di
- aprire un file php e creare una lista di funzioni e classi con relativi metodi, argomenti, proprietà, ecc.
- permetta di creare dal web la documentazione per ogni metodo, argomento, ecc. trovato
- permetta di pubblicare la documentazione in perfetto stile php.net
Naturalmente dovrebbe permettere di gestire più file e di creare categorie all'interno della documentazione, nonchè gestire nuove versioni della documentazione.
Se riuscisse a parsare tutti i file inclusi in una dir sarebbe ancora meglio e volendo fare una chicca non sarebbe male se fosse in grado di collegarsi a SVN/CVS
Ho già passato al pettine sourceforge ma non ho trovato nulla di simile, nemmeno su google
Dite che devo cominciare a svilupparlo da me?
Lungo le due rive del fiume gelato si stendeva la cupa e tetra foresta di abeti, dai quali il vento aveva appena spazzato il manto di brina. Nella luce crepuscolare quegli abeti neri e sinistri sembravano inclinarsi l'uno verso l'altro. Un silenzio minaccioso incombeva sul paesaggio, privo di qualsiasi segno di vita o di movimento, e desolato e freddo al punto da non poter ispirare che un solo sentimento: quello della più triste malinconia. E nello stesso tempo pareva che da quel paesaggio trapelasse una specie di riso, un riso ben più spaventoso di qualsiasi malinconia o tristezza, un riso tragico, come quello di una sfinge, un riso agghiacciante più della brina e che rammendava l'incombere minaccioso dell'ineluttabile. Era la saggezza potente e impenetrabile dell'eternità che irrideva alla vita, alla sua futilità e agli sforzi degli uomini.
perchè detestare una pratica collaudata ormai da più di 10 anni ed inevitabilmente comoda ?Originariamente inviato da IroN@xiD
Io ho sempre detestato (ma sicuramente sono io ad essere malato) la documentazione creata tramite i sorgenti, vedi javadoc.
tu vuoi fare il doppio del lavoro per la metà dell'utilità quando scrivere commenti su classi, metodi, funzioni ... e in generale sul codice permette di leggere la documentazione direttamente dal file invece di dover andare chissà dove a cercare quel metodo di quella classe di quell'applicativo ... non so se mi sono spiegato.
Questo, presumo, il motivo per cui tutti i linguaggi hanno un sistema analogo a quello Javadoc, invidiatissimo e raramente ben replicato, phpdoc è un esempio ben riuscito come pydoc e tutti gli altri.
Addiritura alcuni IDE parsano il file e mentre scrivi ti mostrano la documentazione in tempo reale della funzione/metodo che stai utilizzando ... meglio di così non c'è niente ... imho
era li appositamente per evitare risposte di questo genere(ma sicuramente sono io ad essere malato)
Comunque, non posso che risponderti che anche se il sistema può essere collaudatissimo, utilissimo ed insostituibile posso comunque preferirne un altro.
Potrebbe essere che non ho voglia di infestare il codice di commenti strataggati, potrebbe essere che non mi piace scriverli mentre programmo, può essere che sono viziato e voglio fare questo genere di cose dall'interfaccia web.
Infine posso anche essere malato come ho già detto.
Sono convinto che se tanti usando quel sistema ci sarà un motivo, magari anche condivisibile, ma potrebbe non combaciare con le mie necessità.
Credo che sia il motivo per cui esistono decine di linguaggi di programmazione, decine di distribuzioni, decine di cose diverse al mondo che svolgono più o meno la stessa funzione.
Lungo le due rive del fiume gelato si stendeva la cupa e tetra foresta di abeti, dai quali il vento aveva appena spazzato il manto di brina. Nella luce crepuscolare quegli abeti neri e sinistri sembravano inclinarsi l'uno verso l'altro. Un silenzio minaccioso incombeva sul paesaggio, privo di qualsiasi segno di vita o di movimento, e desolato e freddo al punto da non poter ispirare che un solo sentimento: quello della più triste malinconia. E nello stesso tempo pareva che da quel paesaggio trapelasse una specie di riso, un riso ben più spaventoso di qualsiasi malinconia o tristezza, un riso tragico, come quello di una sfinge, un riso agghiacciante più della brina e che rammendava l'incombere minaccioso dell'ineluttabile. Era la saggezza potente e impenetrabile dell'eternità che irrideva alla vita, alla sua futilità e agli sforzi degli uomini.
... e non a caso, per certe "cose" esistono gli standards ... l'approccio javadoc è uno standard de facto.
Lo sai perchè ?
Perchè hai i commenti sul metodo e se cambi qualcosa non devi fare alcun giro astruso, banalmente scorrere più su ed aggiungere note sulla modifica di quella versione, cambiamenti e quant'altro ...questa si chiama manutenzione, tu non ne hai bisogno ? tu preferisci leggere lo storico del metodo da un'altra parte, lavorare sul metodo, aggiornare dall'altra parte la documentazione per non permettere a nessuno, una volta scaricata la sola classe dell'applicativo di avere a portata di mano i commenti senza doverli cercare ?
Liberissimo di procedere col tuo applicativo personale che, secondo il mio umile punto di vista, solo tu utilizzerai.
E' vero che il mondo è bello perchè è vario, ma è anche vero che la gente per bere porta il bicchiere alla bocca, non lo morde in verticale per fare una capriola veloce ... poi se hai validi motivi per ritenere un sistema comodo a tutto il mondo "scomodo" o altro ancora, siamo tutti qui pronti ad ascoltare quali migliorie introdurrebbe la tua proposta.
edit: noflame
andr3a, ti ringrazio e hai tutte le tue ragioni, ma sto cercando qualcosa di diverso
Lungo le due rive del fiume gelato si stendeva la cupa e tetra foresta di abeti, dai quali il vento aveva appena spazzato il manto di brina. Nella luce crepuscolare quegli abeti neri e sinistri sembravano inclinarsi l'uno verso l'altro. Un silenzio minaccioso incombeva sul paesaggio, privo di qualsiasi segno di vita o di movimento, e desolato e freddo al punto da non poter ispirare che un solo sentimento: quello della più triste malinconia. E nello stesso tempo pareva che da quel paesaggio trapelasse una specie di riso, un riso ben più spaventoso di qualsiasi malinconia o tristezza, un riso tragico, come quello di una sfinge, un riso agghiacciante più della brina e che rammendava l'incombere minaccioso dell'ineluttabile. Era la saggezza potente e impenetrabile dell'eternità che irrideva alla vita, alla sua futilità e agli sforzi degli uomini.
Permessi di invio
Rispondi quotando