Noter og opgaver - Institut for Matematik og Datalogi
Noter og opgaver - Institut for Matematik og Datalogi
Noter og opgaver - Institut for Matematik og Datalogi
Create successful ePaper yourself
Turn your PDF publications into a flip-book with our unique Google optimized e-Paper software.
<strong>Noter</strong> til Pr<strong>og</strong>rammering A<br />
A.3 Retningslinier <strong>for</strong> pæn kode<br />
A.3 Retningslinier <strong>for</strong> pæn kode<br />
På Sun’s hjemmeside er der udførlige guides til hvordan pæn JAVA-kode skal<br />
skrives. Det kan findes her: http://java.sun.com/docs/codeconv/<br />
Pæn kode er <strong>og</strong>så med til at du selv kan læse din egen kode, <strong>og</strong> andre hurtigere<br />
kan hjælpe hvis du har problemer, eller der er n<strong>og</strong>et der ikke virker. Her er n<strong>og</strong>le<br />
af de vigtigste ting.<br />
Navngivning<br />
• Brug meningsfyldte navne. rente <strong>og</strong> temperatur <strong>for</strong>tæller meget mere<br />
end x <strong>og</strong> y<br />
• Klasser starter med stort<br />
• Metoder <strong>og</strong> variable starter med småt<br />
• Konstanter er skrevet med kun store b<strong>og</strong>staver<br />
Kommentarer<br />
• Alle klasser skal have en kommentar lige over klassens navn.<br />
• Alle metoder skal have en kommentar over metoden<br />
• Hvis din kode ikke er let at <strong>for</strong>stå skal den kommenteres.<br />
Layout<br />
• Alle statements i en blok indrykkes 4 mellemrum (eller 1 tab)<br />
• Brug altid tuborg parenteser i if/else <strong>og</strong> loops. Også hvis det kun er én<br />
statement.<br />
• Brug en tom linie mellem metoder (<strong>og</strong> konstruktorer)<br />
• Brug mellemrum omkring operatorer (+,-,*, etc.)<br />
Restriktioner i spr<strong>og</strong>et<br />
• Rækkefølgen i klassen skal være:<br />
1. Import statements<br />
2. Klasse kommentar<br />
3. Klasse header<br />
4. Instans variable<br />
5. Constructor<br />
6. Metoder<br />
• Lav instans variable private, <strong>og</strong> brug get <strong>og</strong> set metoder til at ændre<br />
deres værdier.<br />
• Brug altid public eller private ved metoder.<br />
51
Change language