[Php-it] [semi-ot] Programmazione

[Alessandro Marinuzzi]

Gianluca Baù ha scritto:
> Salve ragazzi,
> una domanda un po' generica sul vostro metodo di lavoro.
>
> Voi tenete una documentazione (cartacea/digitale) su un lavoro (da
> mediamente complesso in su) che state portando avanti ?
> La aggiornate periodicamente? Come la strutturate?
>
> Nel senso:
>
> Sezione --> cosa fa --> variabili coinvolte ? --> funzioni ? --> files
> inclusi ? --> boh ?
>
> Io ho provato tante volte a farlo ma sfortunatamente mi pesa molto
> dover riaggiornare la documentazione ogni volta che cambio qualcosa.
>
> E poi, in ogni file che scrivete inserite delle intestazioni su quello
> che fa, che variabili deve ricevere, etc... ? Una specie di /*
> OVERVIEW: */ intendo.
>
> ...mi piacerebbe conoscere le vostre esperienze.
>
> Saluti
>
> Gianluca
1) Io commento sempre importanti sezioni dei miei script in inglese
ovviamente così chi si mette in mano i miei script lo fa con
tranquillità e prediliggo la versione del commento in stile C++ (// This
is a comment)
2) Mentre porto avanti lo sviluppo di software aggiorno anche la
documentazione così non mi ritrovo molto lavoro da fare ma solo piccoli
aggiornamenti... Per agevolarmi il lavoro predispongo delle sezioni o
dei capitoli nella documentazione che poi riempio...
Esempio:

INTRODUCTION:

REQUIREMENTS:

FEATURES:

CHANGES:

SETTINGS:

TIPS AND TRICKS:

LEGAL:

STATUS:

AUTHOR:

DISCLAIMER:

Eccetera...

3) Metto sotto commento le intestazioni di copyright in tutti i file che
costituiscono il mio progetto
4) Dò un nome al progetto
5) Stabilisco dove deve essere pubblicato e come (vedi licenza - legal)
Ciao :-)

-- 
Alessandro Marinuzzi
--------------------
http://www.alecos.it
--------------------