Coding Standards
- C/C++, Java, e altri linguaggi C-like
- Python
vedi PythonCoding
- TODO
- add missing languages here.
Applicabilita'
Le regole di codifica sono per loro natura del tutto arbitrarie, ma hanno lo scopo di mantenere uniforme lo stile di codifica in modo da semplificare lo scambio di codice tra progetti scritti da persone diverse.
La nostra coding-convention si applica a tutto il software che scriviamo, con alcune eccezioni notevoli:
- Modifiche a progetti esistenti che utilizzano uno standard diverso. A seconda dei casi, possiamo decidere di eseguire un restyling delle parti che modifichiamo oppure adeguarci alle regole originali;
- Linguaggi di programmazione privi di indentazione (e.g.: SQL) o con regole di indentazione proprie (e.g.: make);
- Progetti in cui il cliente ha imposto regole di codifica differenti.
In ogni caso, le convenzioni che continuano ad avere senso devono essere comunque applicate. Il codice esistente non conforme deve essere aggiornato da chi vi apporta modifiche sostanziali.
Proposte di Modifca
Ogni sviluppatore puo' proporre un cambiamento o una chiarificazione del coding standard. L'iter e' il seguente:
Pubblicare la proposta in staff@;
- Concedere alcuni giorni per raccogliere discussioni e repliche;
- Nel caso che non ci sia gia' un chiaro consenso, richidere una votazione formale;
- La proposta e' approvata a maggioranza relativa dei votanti;
- L'autore della proposta e' tenuto ad apportare tutte le modifiche necessarie al Wiki e al codice di esempio;
- La convenzione entra in vigore e deve essere utilizzata da tutti gli sviluppatori e su tutto il codice prodotto;
- Non e' necessario aggiornare immediatamente il codice esistente, ma eventuali modifiche devono essere apportate usando il nuovo standard.
Headers
Nel progetto devtools sono inoltre presenti alcuni templates da utilizzare per la creazione di nuovi file in vari linguaggi.
Tutti i file sorgenti scritti in Develer devono contenere un header standard contenente le informazioni di copyright, i nomi degli autori ed una breve descrizione del file.
Nel caso di modifiche a sorgenti esistenti, e' necessario aggiornare (o aggiungere) l'header:
Aggiungere il copyright Develer, senza rimuovere eventuali altre informazioni di copyright di terze parti;
- Aggiungere l'anno in corso alla lista degli anni di pubblicazione;
- Se le modifiche apportate al codice sono consistenti, aggiungere il proprio nome alla lista degli autori;