Programmierrichtlinien für C - 2

(DI Wittner Michael)

Kommentare

Kommentare müssen klären, aussagekräftig und korrekt sein.
Kommentiere nur, was zum Verständnis des Programmes notwendig ist.
Kommentare sind einheitlich in Deutsch oder Englisch zu schreiben

Zeilenkommentare

Zeilenkommentare stehen entweder vor der zu kommentierenden Codesequenz mit der selben Einrückungstiefe wie die Codesequenz, oder
mit ausreichend Abstand in derselben Codezeile
Verwende ausschließlich /* */
Die Zeilenkommentare sollten auf der selben Einrückungstiefe beginnen.

Dateikommentar

Jede Quellcodedatei enthält am Beginn einen standardisierten Blockkommentar, der wie folgt aussieht:

/*------------------------------------------------------------------------------
* Höhere Technische Bundeslehranstalt STEYR
* Fachrichtung Elektronik - Ausbildungszweig Informatik
*-------------------------------------------------------------------------------
* Modul : Modulname
* Erstautor: Nachname Vorname
* Klasse : Klasse/Jahrgang
* Datum : Erstellungsdatum
*-------------------------------------------------------------------------------
* Modulbeschreibung:
* Hier beginnend
* ...
*-------------------------------------------------------------------------------
*/

Funktionskommentar

Leite jede Funktion mit einem kurzen Kommentar ein, der den Zweck beschreibt.

Funktion mit kommentierten Parametern (in Deklaration):

/*------------------------------------------------------------------------------
* Funktion mit kommentierten Parametern
* IN: par1 Kommentar1
* par2 Kommentar2
* INOUT: par3 Kommentar3
* RETURN:
*/
void Function(int par1, int par2, int par3);

Funktion mit unkommentierten Parametern (in Implementierung):

/*------------------------------------------------------------------------------
* Funktion mit unkommentierten Parametern
*/
void Function(int par1, int par2){
int i, j, k; /* lokale Variablen */
}

/*------------------------------------------------------------------------------
* Funktion mit unkommentierten Parametern (Version 2)
*/
void Function(int par1, int par2)
{
int i, j, k; /* lokale Variablen */
}

< Zurück | Vorwärts | Inhalt >