Informatikmaterialien 
von Tino Hempel

Startseite | Informatik | Physik | Mathematik | Sonstiges |

Richard-Wossidlo-Gymnasium Ribnitz-Damgarten
Fachbereich Informatik

Formatierung und Kommentierung des Quelltextes

Eine gute Quelltextformatierung vereinfacht das Finden von logischen Fehlern. Um nicht etwa das Abschließen einer Verbundanweisung zu vergessen, empfiehlt sich auch bei der Quelltexteingabe darauf zu achten, dass das Programm jeder zeitlauffähig ist.

Eingabereihenfolge der Anweisungen

Man schreibe die zu verwendende algorithmische Grundstruktur stets komplett auf und kommentiere die Lücken. Diese werden im Anschluss nach dem gleichen Prinzip gefüllt. Moderne Java-Editoren setzen mit jeder öffnenden Klammer auch gleich eine schließende.

Beispiel (Java)

 sinnvolle Weise
Schritt 1 
while (i>0)
{
 //kommt später
}
Schritt 2 
while (i>0)
{
 i++;
 d = x % i;
 IO.show(d);
 if (d == 0)
 {
   //kommt später
 }
}
Schritt 3 
while (i>0)
{
 ++i;
 d = x % i;
 IO.show(d);
 if (d == 0)
 {
   d = i;
 }
}
Konsequenz Programm ist stets lauffähig

Einrückungen

Quelltext, der eine Teilstruktur darstellt, ist einzurücken. Es empfehlen sich Kommentare. Damit ergeben sich Konsequenzen für die algorithmischen Grundstrukturen.

Grundstruktur

 Musterbeispiel Hinweise

Verbundanweisung

 
{
  sonne.makeVisible();
  sonne.changeColor("red");
}
 Nach dem Beginn einer Verbundanweisung wird um zwei Zeichen eingerückt, das Ende der Verbundanweisung hebt die Einrückung wieder auf.
Die Empfehlungen von Sun zum Schreiben von Quelltext sieht vor, dass die öffnende Klammer am Ende der darüberliegenden Zeile geschrieben wird.

Selektion

einsteige Selektion

 
if (z == 0)
{  //Kommentar 
  sonne.makeVisible();
  sonne.changeColor("red");
} //end of then
 Unter bestimmten Voraussetzungen können die geschweiften Klammern auch weggelassen werden. Für eine gut lesbare Quelltext empfiehlt es sich aber, diese stets zu setzen.
Das Schlüsselwort else bezieht sich stets auf das letzte if ohne else!

zweiseitige Selektion

 
if (z == 0)
{ //Kommentar 
  sonne.changeColor("yellow");  
  sonne.makeVisible(); 
} //end of then
else
{ //Kommentar
  mond.changeColor("yellow");
  mond.makeVisible();
} //end of else

mehrseitige Selektion

 
switch (zeichen) 
{
  case 1: 
  {
    mond.moveHorizontal(10);
    break;
  }
  case 2:
  { 
    mond.moveHorizontal(-10);
    break;
  }
  case 3:
  { 
    mond.Invisible();
    sonne.Visible();
    break;
  } 
  default: sonne.moveHorizontal(20);
} //end of switch
 Wird in einem Alternativzweig eine Verbundanweisung notwendig, so beginnt diese am entsprechendem Selektor. Gleiches gilt für den Alternativzweig für nicht genannte Selektoren. 

Iteration

abweisende Schleife

 
while (t>0)
{ 
  //begin of while
  mond.moveHorizontal(2);
  sonne.moveVertical(3);
  t = t - 9;
} //end of while
 Unter bestimmten Voraussetzungen können die geschweiften Klammern auch weggelassen werden. Für eine gut lesbare Quelltext empfiehlt es sich aber, diese stets zu setzen.

 

 

nichtabweisende Schleife

 
do 
{
  //begin of do
  mond.moveHorizontal(2);
  sonne.moveVertical(3);
  t = t - 9;
} // end of do - while folgt
while (t>0);

Zählschleife

 
for (int i=1; i<=10; i++)
{
  //begin of for
  sonne.moveHorizontal(10);
} //end of for

Groß- und Kleinschreibungen

Da Java kontextsensitiv arbeitet, ist streng auf die Groß- und Kleinschreibung zu achten. Es gelten folgende Regeln:

Kommentare

Java unterscheidet drei Arten vom Kommentaren

    1. Einzeilige Kommentare:
      werden mit // begonnen und kommentieren die gesamte Zeile aus
    2. Mehrzeilige Kommentare:
      werden mit /* KOMMENTAR */ geklammert
    3. Java-Doc-Kommentare:
      werden zur automatischen Generierung der Dokumentation genutzt
      sind stets für Methoden und Felder auszufüllen
      werden durch /** und */ eingeschlossen
      lassen HTML-Formatierungen zu
      nutzen Sondertags für Parameter (@param) und Rückgabeerläuterungen (@return)

zur Startseite		 © Tino Hempel 1997 - 2006 Im Web vertreten seit 1994.
Eine Internet-Seite aus dem Angebot von Tino Hempel.