Programmierstil - IPD Snelting
Programmierstil - IPD Snelting Programmierstil - IPD Snelting
Dokumentation Programmierstil Namen und Kommentare Sind die Komponenten und Verfahren gut dokumentiert? Kommentiert wird genau das, was nicht offensichtlich ist. der Zweck jeder Klasse, Methode und jeder Variable. der Zweck von komplizierten Programm-Abschnitten. Kommentare geben zusätzliche Informationen. Kommentare bereiten vor und erklären nicht nachträglich. Kommentare stehen immer vor dem Kommentierten. Ausnahme: Kurzkommentare Kommentare und Programmtext sind fortlaufend lesbar. Kommentare und Programmtext nicht mischen. Kommentare sind kurz, präzise und verständlich Prof. Dr.-Ing. G. Snelting (Uni Karlsruhe) c○2008 by IPD Snelting – Programmieren WS 2008/2009 8 / 31
Beispiel 2 Programmierstil Namen und Kommentare Zweck einer Methode /* * Return the greatest common divisor of ‘x’ and ‘y’. * Use the euclidian algorithm. */ public static int gcd(int x, int y) { ... } Zweck einer Anweisung // recompute the size because the base configuration changed actualSize = ... Prof. Dr.-Ing. G. Snelting (Uni Karlsruhe) c○2008 by IPD Snelting – Programmieren WS 2008/2009 9 / 31
- Seite 1 und 2: Programmieren Prof. Dr.-Ing. Gregor
- Seite 3 und 4: Programmierstil Grundsätzliches Wa
- Seite 5 und 6: Programmierstil Grundsätzliches Wi
- Seite 7: Beispiel 1 Programmierstil Namen un
- Seite 11 und 12: Beispiel 4 Schlecht: Programmiersti
- Seite 13 und 14: Beispiel 5 Programmierstil Programm
- Seite 15 und 16: Beispiel 6 Programmierstil Programm
- Seite 17 und 18: Beispiel 7 Programmierstil Programm
- Seite 19 und 20: Beispiel 8 - Schlecht Programmierst
- Seite 21 und 22: Programmierstil Programmstruktur un
- Seite 23 und 24: Programmierstil Programmstruktur un
- Seite 25 und 26: Beispiel 10 Programmierstil Program
- Seite 27 und 28: Beispiel 12 Programmierstil Weitere
- Seite 29 und 30: Programmierstil Allgemeine Programm
- Seite 31: Programmierstil Allgemeine Programm
Beispiel 2<br />
<strong>Programmierstil</strong><br />
Namen und Kommentare<br />
Zweck einer Methode<br />
/*<br />
* Return the greatest common divisor of ‘x’ and ‘y’.<br />
* Use the euclidian algorithm.<br />
*/<br />
public static int gcd(int x, int y) { ... }<br />
Zweck einer Anweisung<br />
// recompute the size because the base configuration changed<br />
actualSize = ...<br />
Prof. Dr.-Ing. G. <strong>Snelting</strong> (Uni Karlsruhe) c○2008 by <strong>IPD</strong> <strong>Snelting</strong> – Programmieren WS 2008/2009 9 / 31
Change language