RegoleScritturaCodiceAD0708 < Programmazione1/AA0708/AD

Tags: view all tags

<table border=2><tr valign=top><td width="90%">

<center>
<font color="red" size="+2">Consigli e regole di scrittura del codice di programmazione.</font>
</center>

<h3>Indentazione del codice</h3>

E' bene che il vostro codice sia indentato in modo adeguato.
All'interno del corpo di una funzione (fin'ora cio' che avete visto e' la funzione main), oppure di 
un ciclo (ad esempio for, while etc)
ogni riga che segue la dichiarazione della funzione, deve essere indentata rispetto a quest'ultima.
Esempio: (una barra - indica che c'e' uno spazio)

_int main () {_

  _--prima riga interno main_

  _--seconda riga interno main_

  --.....

  _--return 1;_

_}_

E' fortemente indicato ad utilizzare 2 spazi per l'indentazione all'interno del corpo della funzione(o ciclo etc).


Se ci sono due funzioni (oppure cicli annidati, oppure un ciclo dentro una funzione) l'indentazione di una riga del 
codice deve essere fatta rispettivamente al corpo del comando di cui appartiene. 
Esempio:


_int main () {_

  _--for (/* condizioni for */) {_

    _----prima riga dentro il for_

    _----seconda riga dentro il for_

    ----.....

  _--}  // chiude il for_

  _--altra riga dentro il main_

  --...

  _--return 1;_

_}  // chiude il main_



<h3>Spazi</h3>

Ogniqualvolta ci sono delle parentesi graffe di apertura e chiusura del corpo di una funzione/comando etc.
la regola più comune è quella di:

1. Mettere la prima parentesi graffa (quella che apre il corpo) nella stessa riga del nome della funzione/commando etc.

2. La prima parentesi graffa deve essere preceduta da uno spazio vuoto.

3. Subito dopo la parentesi graffa deve esserci un accapo (eccezione solo nel caso di un commento- vedere sotto)

4. La parentesi graffa che chiude il corpo della funzione/commando etc., deve essere allineata con :
   a) la prima lettera del tipo di ritorno della funzione (nel caso si tratti di una funzione) esempio:

        _int main () {_

          --.....

          --.....

        _}_


   b) la prima lettera del nome del comando (quando si tratta di un comando)

        _for (...) {_

          _--prima riga dentro il for_

          _--seconda riga dentro il for_

          --.....          

        _}_


Ogniqualvolta ci sono delle parentesi tonde (quelle relative alle condizioni di un comando oppure alle variabili di input
nel caso di una funzione), e' di uso comune:

  1. Mettere uno spazio che precede la parentesi tonda di apertura

  2. Mettere uno spazio dopo la parentesi tonda di chiusura (ossia dividere con uno spazio la parentesi tonda di chiusura 
      e cio' che viene dopo di questa- ad esempio un eventuale parentesi graffa etc.)

Esempio:

*Funzione*

_int main () {_

*Comando*

_for () {_


All'interno delle parentesi tonde (sia quelle riguardanti le funzioni, che quelle riguardanti i comandi), 
l'uso degli spazi è bene che sia il seguente:

  1. Nessuno spazio dopo la prima parentesi tonda- quella di apertura

  2. Dopo ciascuna (eccetto l'ultima) dichiarazione di variabile di input (caso di funzione), 
      oppure della prima condizione (caso di comando), mettere una virgola (caso di funzione), 
      oppure un punto e virgola (caso di comando), seguito subito dopo da uno spazio.

Esempi:

*Funzione:*

_int nome_funzione (tipo1 variabile1, tipo2 variabile2, ..., tipoN variabileN)_

*Comando:*

_for (int i = 2; i < 10; i++) {_





<h3>Commenti:</h3>

I commenti che iniziano con due slash di solito si usano per commentare una qualche variabile oppure funzione etc 
e vanno nella stessa riga della variabile oppure funzione etc.
Di solito, trà il codice e il commento rispettivo si devono lasciare 2 spazi.
Tra i due slash e la prima parola di commento, di solito si deve lasciare uno spazio.
Esempio:

_int numero;  // variabile che conterrà un numero intero_

I commenti che iniziano con /* di solito occupano un intera riga (ossia non vengono preceduti - nella stessa riga-
da righe di codice.) Vengono di solito usati per commenti che riguardano pre- e post- condizioni di funzioni: ossia
cio' che una funzione prende in input, e il rispettivo output.
La /* deve essere allineata con il tipo di ritorno della funzione, mentre */ di solito chiude l'ultima riga del 
commento.
Tra' /* e la prima parola del commento deve esserci uno spazio.
Lo stesso tra' l'ultima parola del commento e */.

Esempio:

  _/* Questa funzione prende in input_

     _--due interi a, e b, e da' in output la_

     _--loro somma. */_

  _int somma (int a, int b) {_

    _--righe di codice dentro il corpo della funzione_

    .....


<h3>Ancora sugli spazi</h3>

E' importante che dopo ogni riga di codice (e/o commento) non ci sia nessuno spazio inutile, ma 
l'ultimo simbolo della riga di codice (commento) venga seguito immediatamente da un accapo.
Questo vale anche per le righe vuote.
Esempio:

_int a;*invio*_

_int b;  // commento su b*invio*_

_*invio*_

_continua il codice*invio*_

.......

Il terzo _*invio*_ sta' ad indicare che il programmatore ha volutamente lasciare una riga vuota trà la dichiarazione
della variabile b ed il resto del codice. Questa riga vuota pero' non contiene nessuna spaziatura, soltanto un invio.

</table>

-- Users.RobertoPetroccia - 19 Oct 2007