[Info] Checkliste für guten Code

Moin,

da die meisten hier (inkl. mir) keine professionellen Programmierer sind, ist es sicher sehr interessant, sich mal anzusehen, welche Anforderungen Profis an Code für Embedded Systems stellen.

Wenn man auch nur einige der folgenden Punkte beherzigt, steigt die Qualität, Lesbarkeit und Wartbarkeit vom geschriebenen Code. Und damit die Freude, wenn man damit zu tun hat.

Hier zu Eurer Inspiration mal die Checkliste von einem Typen, dessen Job es u.a. ist, Code Reviews für Embedded Systems durzuführen.

Beste Grüße,

Helmuth

Punkt F-2 ist ganz wichtig :)

Ansonsten ist das meiste davon nicht nur im Embedded Bereich gültig (bis auf Timing und Hardware)

Ich falle meißt schon bei F3 durch:

"F-3. Does the code do anything it should not be doing?" :grin:

Aber ich arbeite daran...

Da der Arduino gar keine rote LED an Bord hat, kann man sich das Kapitel E (Fehlerbehandlung) sparen. 8)

@Stoni, F3 kommt erst nach F2 ;)

michael_x: @Stoni, F3 kommt erst nach F2 ;)

Pssst!

Ich würde F-2 noch erweitern:

Does the code COMPLETELY do what it should be doing?

"Funktioniert fast", "manchmal" oder "meistens" zählt nicht! Meist hilft dann die E-Liste weiter.

A-1 finde ich auch wichtig. Sehr kurze (aber dafür viele) Funktionen führen praktisch automatisch zu guter (oder zumindest leicht nachvollziehbarer) Struktur (S-4). F-10 ergibt sich von selbst daraus.

Schwierigkeiten hab ich öfters mit S-6. Aussagekräftige Namen werden oft elend lang und ein nachvollziehbarer Kommentar, wie und warum man die "magic number" ermittelt hat, wird auch schnell ein kleiner Essay.