Documentazione

Commenti

/***********************************************
 *  Punti nel piano cartesiano                 *
 ***********************************************/
public class Point {
  // campi privati
  private int x,y;
  // Costruttore completo 
  Point (int x1, int y1) {
    x=x1;
    y=y1;
  }
  // test d'uguaglianza
  public boolean equals(Object o) {
    if (o instanceof Point)  {
      return (((Point)o).x == x) && (((Point)o).y == y);
    } else { 
      return false;
    }
  }
}

Api

La distribuzione di Java contiene una documentazione della base di Java sotto forma HTML. Tale documentazione è sotto la directory docs/api/. Per esempio la documentazione per le stringhe è la seguente.

Si può usare il comando javadoc per generare automaticamente tale documentazione di API per nuove class. Javadoc utilizza una convenzione speciale dei commenti per consentire di mettere informazioni pertinenti API. Questi commenti sono della forma /**   **/. Dentro tale commenti si può mettere qualunque codice HTML.

/***********************************************
 *  Punti nel piano cartesiano                 *
 * @author Laurent Théry                       *
 * @version 1.0                                *
 ***********************************************/
public class Point {
  // campi privati
  private int x,y;
  // Costruttore completo 
  Point (int x1, int y1) {
    x=x1;
    y=y1;
  }
  /**  test d'uguaglianza
    @param o l'altro oggetto
    @return true se i due oggetti sono gli stessi
  **/
  public boolean equals(Object o) {
    if (o instanceof Point)  {
      return (((Point)o).x == x) && (((Point)o).y == y);
    } else { 
      return false;
    }
  }
}