[Php-it] [semi-ot] Programmazione

[Cristiano Verondini]

> Generalmente documento le classi, usando la sintassi di javadoc, cosi
> che se dovessi averne bisogno potrei generare la documentazione con
> phpdoc.

    Questa è (sarebbe) un'ottima pratica.

> Chissa perchè non riesco a farlo nei file che includono le classi,
> tendo a documentare solo le cose un po' più "strane".

    La documentazione è sempre un problema nei progetti software. Chi scrive 
codice è abituato a pensare alla documentazione come 'tempo inutile', ma in 
realtà quando si lavora su progetti medio-grandi, è molto di più il tempo 
speso a documentare il codice che non quello speso a realizzarlo.

    Ovviamente il progetto deve partire da una nutrita serie di requisiti 
tecnici, analisi e quant'altro, che già da soli dovrebbero costituire 
abbondante documentazione. Nel software si dovrebbero documentare le 
interfacce (e qui javadoc/phpdoc è ottimo) e poi qualche processo, ma 
soprattutto, come dici tu, le cose più 'strane'.

        Cris

-- 
Cristiano Verondini
http://www.verondini.it  ---   [ICQ: 114 190]