Dazo

Oggi ho scoperto programmi Generare la documentazione del codice

26
Febbraio
2010
Generare la documentazione del codice
Oggi ho scoperto: - programmi

PhpdocNe avevo sempre sentito parlare, ma devo ammettere la mia ignoranza non li avevo mai usati. Sto parlando dei generatori di documentazione, ovvero quei programmi che prendono il codice che hai scritto e ti tirano fuori la documentazione. L'altra settimana ho usato per la prima volta phpDocumentor che genera in automatico la documentazione di un programma scritto in php. Ne sono rimasto entusiasta. Quando vedi il tuo codice documentato ti rendi conto lo vedi in un'ottica completamente diversa ne percepisci la struttura come fossi un esterno e ti rendi conto di tutti gli errori logici che hai fatto. Certo questo poi ti porta a perdere un enormità di tempo per sistemare i commenti in modo da generare una documentazione sensata, però ritengo che sia tempo ben speso. Quello che invece è più pericoloso è che vedendo tutti gli errori concettuali a me personalmente mi è balenata la malsana idea di ristrutturare un codice iniziato alcuni mesi fa e ancora non terminato. Ok, già sono in ritardo per la consegna di questo codice se poi mi metto a ristrutturare tutte le classi e a commentare tutte le funzioni non lo finisco più. D'ora in avanti ovviamente ho deciso che proverò a generare sempre la documentazione delle classi che scriverò però ecco magari i lavori in corso non è il caso. Per completezza aggiungo i link ai programmi che mi sono scaricato per generare codice:
http://www.phpdoc.org/ e per flash http://www.zendoc.org/ . Per flex invece non ho capito se zendoc va bene, ma sicuramente si può usare asdoc che è dell'adobe però il sistema per scrivere i commenti è diverso rispetto ai due programmi precedenti per cui per ora ho deciso di non usarlo.

 

 
  Menu Principale  
   
     
  Progetti