Roadmap. Questioni di stile. 0. Primi passi con Java 1. Buone abitudini

Transcript

1 Modulo di Roadmap 0. Primi passi con Java 1. Buone abitudini Questioni di stile La professionalità di un programmatore si riconosce anche dallo stile con il quale sono scritti i suoi programmi L assenza di stile è indice di pessima qualità del lavoro svolto: essa tipicamente si accompagna a errori, perdite di tempo, inefficienze, brutte figure, arrabbiature, Per questo viene severamente penalizzata sia all esame sia nel mondo del lavoro Buone Abitudini 1

2 Modulo di Abituarsi da piccoli Si sa che le cattive abitudini sono difficili da estirpare: fin dai primi programmi bisogna adottare uno stile corretto Le principali regole di stile da seguire sono molto semplici e diventeranno naturali se seguite da subito Chi non capisce o non accetta questo fatto non ha speranza di diventare un buon programmatore Altruismo ed egoismo Le regole di stile hanno il principale scopo di garantire la facile leggibilità e comprensibilità del codice Quando si lavora in gruppo chi scrive codice illeggibile causa... Quando si va all esame chi scrive codice illeggibile causa... Quando si deve capire il proprio stesso codice chi scrive codice illeggibile causa... Buone Abitudini 2

3 Modulo di Roadmap 0. Primi passi con Java 1. Buone abitudini La scelta dei nomi Scelta dei nomi Durante la programmazione bisogna dare nomi a molte cose (classi, attributi, metodi, argomenti, variabili,...) E' fondamentale dare sempre nomi significativi e autoesplicativi per rendere il codice chiaro e quindi leggibile e manutenibile L'uso di nomi significativi riduce la necessita' di commenti (self commenting code) Buone Abitudini 3

4 Modulo di Usare nomi significativi! public class O private String ms; public O (String( cdd) ms = cdd; public void sal () System.out.println println(ms); Identificatori validi Le regole del linguaggio danno ampia libertà sulla scelta dei nomi (detti anche identificatori o identifiers) Un nome è valido se inizia per un carattere alfabetico o il carattere underscore _ o il carattere dollaro $ contiene solo caratteri alfabetici, numerici, underscore e dollaro è lungo meno di caratteri Buone Abitudini 4

5 Modulo di Convenzioni sui nomi I nomi di costante sono tutti in maiuscolo, si usa _ per evidenziare la separazione in parole, se serve I nomi di classe (e quindi i nomi dei file che ne contengono il codice) iniziano con lettera maiuscola Gli altri nomi iniziano con lettera minuscola Quando i nomi sono composti da più parole si usano le maiuscole per evidenziarne la separazione Es. ContoCorrente, saldoconto, aggiornasaldo, versasuconto N.B. Java è Case Sensitive! Convenzioni sui nomi public class ossequioso private String MioSaluto; VIOLAZIONE GRAVE: nome classe non inizia per maiuscolo Violazione lieve: mancano maiuscole intermedie public ossequioso (String( cosadevodire) MioSaluto = cosadevodire; VIOLAZIONE GRAVE: nome public void Saluta () attributo inizia per maiuscolo System.out.println println(miosaluto); VIOLAZIONE GRAVE: nome metodo inizia per maiuscolo Buone Abitudini 5

6 Modulo di Convenzioni sui nomi VIOLAZIONE GRAVE: nome classe non inizia per maiuscolo public class buongiornomain private final static String saluto_ita = "Buongiorno!"; private final static String saluto_fra = "Bonjour" Bonjour!"; public static void Main (String args[]) VIOLAZIONE GRAVE: nomi di costanti non Ossequioso maggiordomoita, maggiordomofra; sono tutti maiuscoli maggiordomoita = new Ossequioso(saluto_ita ita); maggiordomofra = new Ossequioso(saluto_fra); maggiordomoita.saluta(); maggiordomofra.saluta(); VIOLAZIONE GRAVISSIMA main è un nome con significato speciale il programma non funzionera! Roadmap 0. Primi passi con Java 1. Buone abitudini La scelta dei nomi La disposizione del codice Buone Abitudini 6

7 Modulo di Non siamo macchine Il compilatore digerisce il codice sorgente in qualunque forma sia scritto purchè rispetti le regole del linguaggio Gli uomini invece fanno molta fatica a seguire del codice che, pur rispettando le regole del linguaggio, sia disposto male a livello di andate a capo, allineamenti e parentesi Che voto gli dareste? private String miosaluto; ; public Ossequioso (String cosadevodire) miosaluto = cosadevodire; ; public void saluta ()System.out.println (miosaluto); Buone Abitudini 7

8 Modulo di Regole di scrittura 1 Ogni riga contiene una sola istruzione o definizione ed ogni istruzione o definizione sta su una sola riga Regole di scrittura 1 private String miosaluto; public Ossequioso (String( cosadevodire) miosaluto = cosadevodire; ; public void saluta () System.out.println println(miosaluto); Buone Abitudini 8

9 Modulo di Regole di scrittura 2 Le parti logicamente distinte (definizioni di variabili, definizioni di metodi, ) sono spazialmente separate Regole di scrittura 2 private String miosaluto; public Ossequioso (String( cosadevodire) miosaluto = cosadevodire; ; public void saluta () System.out.println println(miosaluto); Buone Abitudini 9

10 Modulo di Regole di scrittura 3 Ogni parentesi graffa aperta è il primo o l ultimo carattere della sua riga(è preceduta o seguita da un ritorno a capo) Ogni parentesi graffa chiusa è preceduta da un ritorno a capo Tutto ciò che è compreso tra una graffa aperta e la corrispondente chiusa è rientrato (indentato) verso destra di qualche spazio Regole di scrittura 3 private String miosaluto; public Ossequioso (String( cosadevodire) miosaluto = cosadevodire; public void saluta () System.out.println println(miosaluto); Buone Abitudini 10

11 Modulo di Regole di scrittura 4.1 Viene adottato uno stile uniforme per la disposizione delle parentesi graffe aperte e chiuse fra tre possibili Stile 1: ogni graffa sta isolata su una riga, le graffe corrispondenti sono allineate in verticale Regole di scrittura 4.1 private String miosaluto; public Ossequioso (String( cosadevodire) miosaluto = cosadevodire; public void saluta () System.out.println println(miosaluto); Buone Abitudini 11

12 Modulo di Regole di scrittura 4.2 Viene adottato uno stile uniforme per la disposizione delle parentesi graffe aperte e chiuse fra tre possibili Stile 2: ogni graffa aperta sta all inizio di una riga non vuota, la graffa chiusa corrispondente è allineata in verticale Regole di scrittura 4.2 private String miosaluto; public Ossequioso (String( cosadevodire) miosaluto = cosadevodire; public void saluta () System.out.println println(miosaluto); Buone Abitudini 12

13 Modulo di Regole di scrittura 4.3 Viene adottato uno stile uniforme per la disposizione delle parentesi graffe aperte e chiuse fra tre possibili Stile 3: ogni graffa aperta sta alla fine di una riga non vuota, la graffa chiusa corrispondente è allineata in verticale all inizio di tale riga Regole di scrittura 4.3 private String miosaluto; public Ossequioso (String( cosadevodire) miosaluto = cosadevodire; public void saluta () System.out.println println(miosaluto); Buone Abitudini 13

14 Modulo di Roadmap 0. Primi passi con Java 1. Buone abitudini La scelta dei nomi La disposizione del codice I I commenti Commenti Un commento è una parte del file che contiene il codice di una classe che viene marcata in modo tale da essere ignorata dal compilatore Il compilatore si comporta come se i commenti non ci fossero Buone Abitudini 14

15 Modulo di Forma dei commenti // il commento inizia dove compare la doppia sbarra e termina alla fine della riga /* */ il commento inizia dove compare /* e termina alla prima apparizione di */ comprendendo eventualmente più righe Forme dei commenti private String miosaluto; // Unico attributo definito public Ossequioso (String( cosadevodire) miosaluto = cosadevodire; /* Escludo il metodo saluta dalla compilazione public void saluta () System.out.println println(miosaluto); */ Buone Abitudini 15

16 Modulo di Uso dei commenti I commenti hanno tre usi principali 1. Essere letti da altri programmatori (o dall autore stesso tempo dopo) per facilitare la comprensione del codice 2. Escludere temporaneamente dalla compilazione parti di codice contenenti errori o per provare modifiche commentando la versione precedente 3. Essere elaborati da programmi diversi dal compilatore (p.e. generatori automatici di documentazione) Uso dei commenti Il codice ben scritto con nomi autoesplicativi limita la necessità dell uso 1 dei commenti L uso 1 dei commenti è consigliato quando si realizzano codifiche particolarmente complesse L uso 2 dei commenti può essere molto utile nelle fasi di di correzione o modifica di codice e ricerca di errori L uso 3 è consigliato per produrre facilmente documentazione di buona qualità Buone Abitudini 16

17 Modulo di La documentazione Un programma sviluppato professionalmente è SEMPRE accompagnato da documentazione La documentazione descrive le classi e i metodi realizzati e permette la comprensione del codice allo scopo di utilizzarlo o modificarlo E utile sfruttare i sistemi automatici di generazione di documentazione inglobando la documentazione come commento all interno del codice (scriverla a posteriori è noioso e penoso : finisce che non lo si fa) Commenti per javadoc Esiste uno stile che permette la produzione automatica di documentazione con l'utility javadoc /** inizio commento * il commento continua *... * ultima riga testo commento */ Buone Abitudini 17

18 Modulo di Commenti per javadoc Ogni commento javadoc precede ciò a cui si riferisce (intera classe, attributi, metodi) I commenti javadoc possono contenere dei tag (parole speciali precedute che indicano a quale aspetto specifico si riferisce il commento Tag diversi sono appropriati per diverse parti del codice Commenti sull intera classe /** * Questa classe definisce il prototipo * di oggetti che presentano saluti * Gruppo Docenti Infob * */... Il serve a fornire informazioni su chi ha scritto il codice Buone Abitudini 18

19 Modulo di Commenti su attributi /** Il saluto che verra * presentato a video */ private String miosaluto; Questo commento non apparirà perchè l'attributo è private (come capiremo meglio più avanti)... Commenti su metodi... /** * Il solo costruttore definito per la classe: * inizializza il saluto specifico dell'istanza * cosadevodire il saluto da utilizzare */ public Ossequioso (String( cosadevodire) miosaluto = cosadevodire; Il serve a fornire informazioni su ciascun argomento... di un metodo Buone Abitudini 19

20 Modulo di Commenti su metodi... /** * Questo metodo stampa a video un saluto * stabilito per ciascuna istanza * al momento della costruzione Il metodo non restituisce nulla */ public void saluta () System.out.println println(miosaluto); Questo commento non apparirà perchè il metodo è void (come capiremo meglio più avanti) Il serve a fornire informazioni su ciò che viene ritornato dal metodo Usare javadoc Se il codice contiene commenti javadoc è possibile generare la documentazione relativa in formato esplorabile con un web browser La documentazione ufficiale di Java, che useremo spessissimo, è costruita nello stesso modo e con lo stesso formato Buone Abitudini 20

21 Modulo di Roadmap 0. Primi passi con Java 1. Buone abitudini La scelta dei nomi La disposizione del codice I I commenti Organizzazione dei file Un file Una classe Ogni classe è contenuta in un file con estensione.java e nome esattamente uguale a quello della classe (in modo case sensitive) Ogni file quindi contiene esattamente una classe Anche se è possibile ammassare nello stesso file le definizioni di più classi (purchè( non precedute dalla parola public) ) questo è SCONSIGLIATISSIMO Buone Abitudini 21