Documentazione delle classi di un programma

[LordSaga640]

Salve,
la sezione più adatta a questo messaggio mi sembrava questa, ma non ne sono sicuro.

Ho iniziato a scrivere un programma, il problema è che il codice aumenta molto velocemente, e con esso anche le classi e i motodi e le variabili globali.

Tutte le volte mi tocca aprire i relativi file per andare a vedere come si chiamano le funzioni e come richiamarle. Che pizza

Dunque, quello che sto cercando è un programma che mi permetta di creare una guida interattivi dove sia facile aggiornarla in modo rapido.
Cioè: clicco sulla classe e mi dice i parametri dei metodi e le variabili pubblichi.
E tutto collegato tramite link.

Non voglio scrivere una guida in txt, veramente brutta e difficile da consultare, meglio riguardarsi il codice da capo.

GTrazie in anticipo sperando in una pronta risposta ^_^

Ciao ciao!

[LordSaga640]

http://www-306.ibm.com/software/info...V91308R94.html

[LordSaga640]

http://www.mokabyte.it/2000/03/magicdraw.htm

[alka]

Al di là del fatto che poni una domanda e ti rispondi da solo, non capisco la tua difficoltà: come puoi dimenticare le funzionalità delle classi e dei metodi che scrivi per la tua applicazione?

A parte questo, indica almeno il linguaggio così è possibile dare suggerimenti mirati.

[LordSaga640]

Originariamente inviato da alka
Al di là del fatto che poni una domanda e ti rispondi da solo, non capisco la tua difficoltà: come puoi dimenticare le funzionalità delle classi e dei metodi che scrivi per la tua applicazione?

A parte questo, indica almeno il linguaggio così è possibile dare suggerimenti mirati.

Se non ti sei mai posto una simile domanda significa che non hai mai scritto programmi più lunghi di 50KB.
Quando scriverai più di 15 classi ne riparliamo :P

CMQ, il linguaggio è PHP, solo che l'applicazione è un po' grandina, e il problema non dipende dal linguaggio di programmazione.

[alka]

Originariamente inviato da LordSaga640
Se non ti sei mai posto una simile domanda significa che non hai mai scritto programmi più lunghi di 50KB. Quando scriverai più di 15 classi ne riparliamo :P

Ne ho scritte di molto più complesse... sarà che io non ho la memoria corta...

Ripeto: non si capisce di cosa tu abbia bisogno di preciso. Ti serve un software per scrivere la documentazione testuale di classi? Ti serve un tool di modellazione UML? Entrambi?

[LordSaga640]

Originariamente inviato da alka
Ne ho scritte di molto più complesse... sarà che io non ho la memoria corta...

Ripeto: non si capisce di cosa tu abbia bisogno di preciso. Ti serve un software per scrivere la documentazione testuale di classi? Ti serve un tool di modellazione UML? Entrambi?

nu nu, solo creare la documentazione del codice.
Non so quali metodi ci sono.

Qualcosa di un po' più avoluto del blocco note.

Quando devo vedere cosa fa una classe, ci clicco sopra e mi dice i metodi e le variabili pubbliche che posso usare.

[MItaly]

Se usi C# o VB.NET e VS.NET puoi usare la documentazione XML.

[alka]

Originariamente inviato da LordSaga640
Quando devo vedere cosa fa una classe, ci clicco sopra e mi dice i metodi e le variabili pubbliche che posso usare.

In tal caso, dovresti cercare di individuare - magari scrivendo nel forum di PHP - qualche software in grado di supportare un qualsivoglia formato di documentazione, magari fornendo la possibilità di scriverla all'interno del codice PHP che produci, che si integri all'occorrenza all'interno di un IDE esistente per la produzione di codice PHP rendendolo in grado di accedere a queste "meta informazione" e visualizzare, in modo interattivo, la documentazione relativa ad una determinata classe, metodo e così via.

Che dici, sposto in PHP?

[LordSaga640]

Originariamente inviato da alka
In tal caso, dovresti cercare di individuare - magari scrivendo nel forum di PHP - qualche software in grado di supportare un qualsivoglia formato di documentazione, magari fornendo la possibilità di scriverla all'interno del codice PHP che produci, che si integri all'occorrenza all'interno di un IDE esistente per la produzione di codice PHP rendendolo in grado di accedere a queste "meta informazione" e visualizzare, in modo interattivo, la documentazione relativa ad una determinata classe, metodo e così via.

Che dici, sposto in PHP?

Sto provando Rational rose della Rational. E' programma apposito per creare la documentazione di qualsiasi programma con l'aggiunta di alcune specifiche per certi linguaggi più usati. C'è anche la specifica per linguaggi generici, il che permette, come nel mio caso di fare una documentazione accurata...

Ah, mentre sto scrivendo, proprio in alto c'è il banner della IBM della rational.... ROFLT

Basta, dopo questo posso anche formattare il mondo.


Format mondo:

Ciao XD