1 / 8

Java

Java. Linee guida per la programmazione. Convenzioni per gli identificatori (nomi). Tutti i nomi degli attributi e dei metodi e tutte le variabili delle classi sono scritti con lettere minuscole (eventualmente con qualche carattereMaiuscolo all'interno); per esempio, sommaValori.

zenia-goodwin
Télécharger la présentation

Java

An Image/Link below is provided (as is) to download presentation Download Policy: Content on the Website is provided to you AS IS for your information and personal use and may not be sold / licensed / shared on other websites without getting consent from its author. Content is provided to you AS IS for your information and personal use only. Download presentation by click this link. While downloading, if for some reason you are not able to download a presentation, the publisher may have deleted the file from their server. During download, if you can't get a presentation, the file might be deleted by the publisher.

E N D

Presentation Transcript

  1. Java Linee guida per la programmazione

  2. Convenzioni per gli identificatori (nomi) • Tutti i nomi degli attributi e dei metodi e tutte le variabili delle classi sono scritti con lettere minuscole (eventualmente con qualche carattereMaiuscolo all'interno); per esempio, sommaValori. • Tutti i nomi delle classi e delle interfacce iniziano con una lettera Maiuscola seguita da lettere minuscole (eventualmente con qualche LetteraMaiuscola all'interno); per esempio, LibroDiTesto. • Tutte le costanti sono scritte con lettere MAIUSCOLE (eventualmente con qualche CARATTERE_DI_SOTTOLINEATURA all'interno); per esempio, NUMERO_STUDENTI.

  3. Convenzioni per gli spazi • Impostate gli arresti di tabulazione a un valore pari a due spazi. • Utilizzate liberamente righe vuote per separare parti di un metodo che sono logicamente distinte. • Mettete uno spazio vuoto prima e dopo qualsiasi operatore binario: • x1 = (-b - Math.sqrt(b * b - 4 * a * c)) / (2 * a); // Ottimo • x1=(-b-Math.sqrt(b*b-4*a*c))/(2*a); // Pessimo • Lasciate uno spazio vuoto dopo (e non prima) ogni virgola e punto e virgola. Non lasciate uno spazio prima o dopo una parentesi tonda o quadra. Lasciate uno spazio attorno alla parte (…) di un enunciato if, while, for o catch. • if (x == 0) y = 0; • f(a, b[i]);

  4. Allineamento e Commenti • Le parentesi graffe devono allinearsi orizzontalmente o verticalmente. • Non ricorrete alle doppie barre // per i commenti che si sviluppano per più di due righe. • Usate invece la notazione /* ... */ per i commenti su più righe. • Disponete i commenti lunghi in questo modo: /* commento altro commento ancora commenti */ • oppure così: /* commento altro commento ancora commenti */

  5. Commenti per Classi • N.B. I commenti vanno inseriti dopo le eventuali istruzioni di include. • Il commento che spiega lo scopo della classe deve essere nel formato che viene riconosciuto dal programma javadoc. • Inizia con /** e usa i marcatori @author e @version • Esempio /** Sintetico commento sulla classe @author Cognome e Nome @version gg-mm-aaaa */

  6. Commenti per Attributi • Per ogni attributo va inserito un commento che ne chiarisca il significato • Esempio: /** Classe punto @author Classe IVB Informatica @version 09-11-2006 */ public class Punto { /** ascissa */ private double x; /** ordinata */ private double y;

  7. Commenti per Costruttori • Per ogni costruttore va inserito un commento che ne chiarisca il significato e i parametri • Esempio /** Nessuna valorizzazione delle coordinate */ public Punto(){ } /** Valorizzazione delle coordinate con i parametri passati @param vx ascissa @param vy ordinata */ public Punto(double vx, double vy){ x=vx; y=vy; }

  8. Commenti per Metodi • Lasciare una riga vuota dopo ciascun metodo. • Ciascun metodo (salvo il metodo main) inizia con un commento in formato javadoc: /** Commento sintetico @param <nomeDelParametro> <significato> @param … @return <significato del valore ritornato se non void> */

More Related