Convenzioni per la codifica

Sorgente

Il suffix di un file che contiene codice java è .java

Il suffix di un file che contiene il bytecode è .class

Un file sorgente non deve essere più lungo di 2000 righe di codice.

Un file contiene al massimo una class pubblica o una interface pubblicca. La class pubblica o la interface pubblica è la prima class dichiarata dentro il file.

Un file sorgente inizia con un commento:

/* 
 * Il nome della class
 * La versione
 * La data
 * Il copyright che si applica
 */

package mio.package;

import altro.package1.Object1;
import altro.package1.Object2;
import altro.package2.Object3;

Dichiarazioni di class e interface

/**
 * Descrizione  della class 
 *
 * @version il numero di versione e la data
 * @author  l'autore della class
 **/

public class Point {

1. le variabili statiche in ordine di visibilità (prima public, protected, default, private):

   /** commento per scale */
   public static int scale;
   
   /** commento per number */
   private static int number;
   

2. i campi in ordine di visibilità (simile a quello delle variabili statiche):

   /** commento per x */
   public int x;
   
   /** commento per y */
   public int y;
   

3. i costruttori:

   /** commento per il primo costruttore */
   Point(int x, int y) {
     ...
   }
   
   /** commento per il secondo costruttore */
   Point(int x) {
     ...
   }
   

4. i metodi raggruppati per funzionalità piuttosto che ordinati per visibilità:

    /** commento per il metodo */
    int distanceToOrgin() {
     ...
   }
   

Scelta dei nomi

Package

package it.univaq.lsp.progetto;

Class

class PuntoColorato {
  ...
}

Interface

Metodi

int getX() {
 ...
}

Indentazione

• Tagliare dopo la virgola
• Tagliare prima di un operatore (+, -, *, /, %)
• Allineare la nuova riga con l'espressione allo stesso livello nella riga precedente. Preferire un taglio iniziale che un taglio finale. Meglio

   method(expression1, 
          object1.method2(expression2, expression3));
  

  che

   method(expression1, object1.method2(expression2, 
                                       expression3));
  

• Se c'è ambiguità, aggiungere 2 indentazioni. Per esempio:

    if ((condition1 && condition2) 
        || condition3) {
        break;
    }
  

  il break e l'ultima condizione si confondono. Meglio

    if ((condition1 && condition2) 
                || condition3) {
        break;
    }
  

Dichiarazione

Variabile

• una dichiarazione per riga,
• sempre inizializzate,
• all'inizio dei blocchi.

void method() {
  int int1 = 0; //inizio del block del metodo
  if (test) {
    int int2 = 0; // inizio del block del then
    ...
  }
  ...
} 

Metodo

int getX() {
     return x;
}

Istruzioni

If

  if (test) {
      ...
  }

  if (test) {
      ...
  } else {
      ...
  }

For

  for (init; test; incr) {
      ...
  }

While

  while (test) {
      ...
  }

DoWhile

  do {
      ...

  } while (test) 

Switch

  switch (test) {
  case 1:
      istruzione;
      /* No break */
  case 2:
      istruzione;
       break;
  case 3:
      istruzione;
       break;
  default:
      istruzione;
  }

Try Catch

 
try {
    istruzione;
} catch (Exception e) {
    istruzione;
} finally P
    istruzione;
}

Spazi bianchi

Riga

Spazio bianco

• fra una parola chiave (if, while, for) e la sua parentesi (:

  while (true) {
      ...
  }
  

• dopo una virgola nella lista degli argomenti:

  Point(int x, int y) {
      ...
  }
  

• prima e dopo un operatore binario (+, -, *, / , %):

    return (a + b) * c;
  

• dopo un punto e virgola in un for:

    for (int i = 0; i < 10; i++) {
         ...
    }
  

• fra il tipo del cast e la sua espressione:

    ((Point) o).getX()
  

Pratica

Ordine dei modificatori

(public o protected o private o niente) dopo (abstract o static o niente) dopo (final o niente).

Per esempio:

class A {
  public static final int VAL = 1;
  private int x;
  public final int getX() {
    return x;
  }
}

Valori

class A {

  boolean getAnswer() throws NoAnswerException {
    for (int i = 0; i < 10; i++) {
      printMessage("Yes or No?");
      String s = readAnswer();
      if ("Yes".equals(s)) {
        return true;
      } else ("No".equals(s)) {
        return false;
      }
    }
    throw new NoAnswerException();
  }
}

class A {

  static final String MESSAGE = "Yes or No?";
  static final String YES = "Yes";
  static final String NO = "No";
  static final int ITER = 10;

  boolean getAnswer() throws NoAnswerException {
    for (int i = 0; i < ITER; i++) {
      printMessage(MESSAGE);
      String s = readAnswer();
      if (YES.equals(s)) {
        return true;
      } else (NO.equals(s)) {
        return false;
      }
    }
    throw new NoAnswerException();
  }
}