Konventionen zur Namensgebung und Kommentierung im Quelltext

• Klassen werden groß geschrieben. Alle Anfangsbuchstaben innerhalb des Klassennamens werden groß geschrieben.
• Klassennamen enthalten Substantive.
• Variablennamen werden klein geschrieben.
• Variablennamen haben sprechende Namen, die durchaus etwas länger sein können.
• Membervariablen werden klein geschrieben.
• Funktionen/Methoden haben die gleiche Groß- und Kleinschreibung, wie Variablen.
• Funktionen/Methodennamen enthalten Verben
• Konstanten bestehen nur aus Großbuchstaben, Wörter in den Konstantennamen werden durch "_" getrennt.
• Kommentare für Funktionen/Methoden, falls überhaupt nötig, enthalten: -- Eine allgemeins Beschreibung der Funktion/Methode -- Eine Beschreibung jedes einzelnen Parameters -- Eine Beschreibung des Rückgabewertes -- Der zulässige Wertebereich der Parameter und der Wertebereich des Rückgabewertes -- Besonderheiten (z.B. geworfene Exceptions,...)
• Auch Klassen können Kommentare enthalten, in denen Allgemeines über die Klasse steht.
• Alle Bezeichner auf Englisch.
• Alle Kommentare auf Deutsch!
• Einrückung nach VS Code/Arduino IDE Autoformatieren

Konventionen zur Programmierung

• In jede Headerdatei gehört : #ifndef.. #define.. #endif
• Jede Funktion/Methode soll nur eine Aufgabe übernehmen.
• Jede Funktion/Methode erhält die von ihr benötigten Daten per Parameter (am besten als Referenz) -> damit werden die Funktionen/Methoden besser testbar
• Jede Funktion/Methode soll mit einem oder mehreren Unittests getestet werden, soweit das möglich ist.
• Jede Funktion/Methode soll nach Fertigstellung von einem Kollegen einem Review unterzogen werden.

Beispiel Quelltext

#ifndef CODE_CONVENTIONS_H
#define CODE_CONVENTIONS_H

#define KONST_TO_SHOW

class ClassForDemonstration
{
private:
    byte member_example_1;
    byte memberExample2;

public:
    byte get_member_1() { return member_example_1; };
    byte getMember2() { return memberExample2; };
    void set_member_1(byte aValue) { member_example_1 = aValue; };
    void setMember2(byte aValue) { memberExample2 = aValue; };
};

ClassForDemonstration demo_object;

void setup()
{
    Serial.begin(115200);
}

void loop()
{
    fill_object(demo_object);
    serial_out_object(Serial, demo_object);
    Serial.println();
}

void fill_object(ClassForDemonstration &aObject)
{
    aObject.set_member_1(millis());
    aObject.setMember2(millis());
}

void serial_out_object(Stream &aStream, ClassForDemonstration &aObject)
{
    aStream.print(aObject.get_member_1());
    aStream.print("\t");
    aStream.print(aObject.getMember2());
}

#endif