Unterschiede
Hier werden die Unterschiede zwischen zwei Versionen angezeigt.
Beide Seiten der vorigen Revision Vorhergehende Überarbeitung Nächste Überarbeitung | Vorhergehende Überarbeitung | ||
microcontrollertechnik:vorgaben_fuer_die_softwareentwicklung [2021/06/21 02:02] tfischer |
microcontrollertechnik:vorgaben_fuer_die_softwareentwicklung [2024/06/20 00:25] (aktuell) mexleadmin [Bewertung] |
||
---|---|---|---|
Zeile 34: | Zeile 34: | ||
| | ||
- | Software: | + | Software: |
Funktion: | Funktion: | ||
Zeile 61: | Zeile 61: | ||
=============================================================================*/ | =============================================================================*/ | ||
- | </code> | + | </sxh> |
++++ | ++++ | ||
Zeile 156: | Zeile 156: | ||
++++Beispiel für Konstanten| | ++++Beispiel für Konstanten| | ||
+ | {{tablelayout? | ||
|<fc # | |<fc # | ||
// Konstanten | // Konstanten | ||
Zeile 203: | Zeile 204: | ||
* Variablen beginnen mit Kleinbuchstaben. | * Variablen beginnen mit Kleinbuchstaben. | ||
* Falls Sie aus mehreren Wörtern zusammengefügt sind, so werden die folgenden Wörter **ohne Unterstrich** | * Falls Sie aus mehreren Wörtern zusammengefügt sind, so werden die folgenden Wörter **ohne Unterstrich** | ||
- | * Vermeiden Sie zu allgemeine Namen, wie anzahl, uebergabewert oder string. Sinnvoller sind Namen, wie anzahlBuchstaben, | + | * Vermeiden Sie zu allgemeine Namen, wie anzahl, uebergabewert oder string. Sinnvoller sind Namen, wie '' |
* Nutzen sie auch bei Zählvariablen aussagekräftige Namen. | * Nutzen sie auch bei Zählvariablen aussagekräftige Namen. | ||
- | * Auch kann eine zu allgemeine Deklaration kann zu Problemen führen. Schlecht ist z.B. "int a;". | + | * Auch kann eine zu allgemeine Deklaration kann zu Problemen führen. Schlecht ist z.B. '' |
- | * Es bietet sich an bei der Definition bereits zu initialisieren. Gut ist also "bool a=1;". | + | * Es bietet sich an bei der Definition bereits zu initialisieren. Gut ist also '' |
++++Beispiel für Variablen| | ++++Beispiel für Variablen| | ||
Zeile 236: | Zeile 237: | ||
* Teilen Sie Ihr Projekt in sinnvolle Unterstrukturen. Diese sind meist Funktionen. Die Unterstrukturen sollten nicht zu groß werden, um die Übersichtlichkeit zu bewahren. | * Teilen Sie Ihr Projekt in sinnvolle Unterstrukturen. Diese sind meist Funktionen. Die Unterstrukturen sollten nicht zu groß werden, um die Übersichtlichkeit zu bewahren. | ||
- | * Bei größeren Programmen ist auch die Aufteilung in mehrere Dateien sinnvoll, also z.b. main.c, LED.c, motorDriver.c. Dabei sollte darauf geachtet werden, dass globalen Variablen und Konstanten jeweils nur im Kontext der einzelnen Dateien genutzt werden und, dass header-Dateien angelegt werden. Das ermöglicht ein separates Testen der unterschiedlichen Dateien (z.B. mit einer Datei testLED.c, welche LED.h inlcude't). | + | * Bei größeren Programmen ist auch die Aufteilung in mehrere Dateien sinnvoll, also z.b. '' |
- | * Nutzen Sie den Zeileneinschub den AtmelStudio | + | * Nutzen Sie den Zeileneinschub den Microchip Studio |
- | * Für die Benennung von Funktionen bietet sich - wie bei Variablen - camelCase an. Zum leichteren Verständnis sollten die Funktionsnamen aus Objekt(e) und Verb zusammengesetzt werden (z.B. bool isI2cMessageNotSent() oder void sentI2cMessage()). Damit wird der Code besser lesbar, Z.B. '' | + | * Für die Benennung von Funktionen bietet sich - wie bei Variablen - camelCase an. Zum leichteren Verständnis sollten die Funktionsnamen aus Objekt(e) und Verb zusammengesetzt werden (z.B. '' |
* Vermeiden Sie zu viele Leerzeilen. | * Vermeiden Sie zu viele Leerzeilen. | ||
* Stellen Sie auch jeder Funktion eine kurze Beschreibung voran. Aus dieser sollte hervorgehen, | * Stellen Sie auch jeder Funktion eine kurze Beschreibung voran. Aus dieser sollte hervorgehen, | ||
Zeile 274: | Zeile 275: | ||
return 0; | return 0; | ||
} | } | ||
- | </ | + | </ |
++++ | ++++ | ||
Zeile 441: | Zeile 442: | ||
... | ... | ||
switch(i) { | switch(i) { | ||
- | case 1, 2, 6...9 : doOne; | + | case 1: |
- | case 3: doThree; | + | case 2: // Einzelne Zahlen können mit case's untereinander ... |
+ | case 6 ... 9: doOne; | ||
+ | case 3: doThree; | ||
case 4: doFour; | case 4: doFour; | ||
case 5: doFive; | case 5: doFive; | ||
Zeile 621: | Zeile 624: | ||
++++ | ++++ | ||
- | * _delay_ms() und _delay_us() sind zu 99% nicht notwendig. Verwenden Sie stattdessen Interrupts, bzw. Timer. Es können z.B. durch Interrupts Takte angelegt werden: takt10ms, takt100ms, takt1s. Diese können dann im main() Verzweigungen in einer Zustandsmaschine | + | * _delay_ms() und _delay_us() sind zu 99% nicht notwendig. Verwenden Sie stattdessen Interrupts, bzw. Timer. |
+ | * Häufig bietet es sich an, in den Takten dann auch Verzweigungen in einer Zustandsmaschine | ||
* Wenn Sie Zahlen in Variablen speichern und diese auch mathematisch weiterverwenden, | * Wenn Sie Zahlen in Variablen speichern und diese auch mathematisch weiterverwenden, | ||
++++Beispiel für Variablen mit Ausgabe| | ++++Beispiel für Variablen mit Ausgabe| | ||
Zeile 651: | Zeile 655: | ||
====== Bewertung ====== | ====== Bewertung ====== | ||
- | Zur Bewertung lege ich {{checkliste_250520.pdf|diese Checkliste}} | + | Zur Bewertung lege ich {{microcontrollertechnik: |