Unterschiede

Hier werden die Unterschiede zwischen zwei Versionen angezeigt.

--- microcontrollertechnik:vorgaben_fuer_die_softwareentwicklung [2021/05/09 11:14]
127.0.0.1 Externe Bearbeitung
+++ microcontrollertechnik:vorgaben_fuer_die_softwareentwicklung [2024/06/20 00:25] (aktuell)
mexleadmin [Bewertung]
@@ Zeile 19: / Zeile 19: @@
 ++++Beschreibung|
-<code c>
+<sxh c; first-line: 1>
 /* ============================================================================
@@ Zeile 34: / Zeile 34: @@
                  AVR-USB-PROGI Ver. 2.0
-Software:        Atmel Studio Ver. 7.0.1417
+Software:        Microchip Studio Ver. 7.0.1417
 Funktion:        Diese Programm sol eine einfaches Beispiel der Ein- und Ausgabe am MiniMEXLE sein.
@@ Zeile 61: / Zeile 61: @@
 =============================================================================*/
-</code>
+</sxh>
 ++++
@@ Zeile 68: / Zeile 68: @@
 ++++Beispiel für Code-Kommentierung|
-|<fc #800000>**SCHLECHT**</fc>| <code c>
+|<fc #800000>**SCHLECHT**</fc>| <sxh c; first-line: 1>
 if(i==0) output=0; // wenn i = 1, output=0
-</code>       |
+</sxh>      |
-|<fc #008000>**GUT**</fc>| <code c>
+|<fc #008000>**GUT**</fc>| <sxh c; first-line: 1>
 if(i==0) output=0; // nur für erstes Element wird der Output zurückgesetzt
-</code>       |
+</sxh>      |
 ++++
@@ Zeile 81: / Zeile 81: @@
 ++++Beispiel für auskommentierten Code|
-|<fc #800000>**SCHLECHT**</fc>| <code c>
+|<fc #800000>**SCHLECHT**</fc>| <sxh c; first-line: 1>
 ...
     if (i==1) output("eins");    // ToBeChanged: noch an Zähler anpassen
@@ Zeile 90: / Zeile 90: @@
 ...
-</code>       |
+</sxh>      |
-|<fc #008000>**GUT**</fc>| <code c>
+|<fc #008000>**GUT**</fc>| <sxh c; first-line: 1>
 ...
     if (i==STARTWERT) LCDoutput(startAusgabe);   // nur bei i=1 erfolgt eine Ausgabe
@@ Zeile 97: / Zeile 97: @@
                         // Ausgabe, weil i <=1
 ...
-</code>       |
+</sxh>      |
 ++++
@@ Zeile 107: / Zeile 107: @@
 ++++Beispiel für die vordefinierten Makros|
-|<fc #800000>**SCHLECHT**</fc>| <code c>
+|<fc #800000>**SCHLECHT**</fc>| <sxh c; first-line: 1>
 #define    TWICE(x)    2*x // Port-Bit Setzen
@@ Zeile 121: / Zeile 121: @@
     ...
 }
-</code>       |
+</sxh>      |
-|<fc #008000>**GUT**</fc>| <code c>
+|<fc #008000>**GUT**</fc>| <sxh c; first-line: 1>
 // Makros
@@ Zeile 137: / Zeile 137: @@
     ...
 }
-</code>       |
+</sxh>      |
 ++++
@@ Zeile 148: / Zeile 148: @@
   * Konstanten per ''#define'' oder ''enum'' sind komplett in **Großbuchstaben** zu schreiben, um diese von Variablen zu unterscheiden.
   * Falls Sie aus mehreren Wörtern zusammengefügt sind, sollten Sie **mit Unterstrich**  getrennt werden.
-<code c>
+<sxh c; first-line: 1>
 enum tage {MONTAG, DIENSTAG, MITTWOCH, DONNERSTAG, FREITAG, SAMSTAG, SONNTAG};
 for (enum tage aktuellerTag = MONTAG; aktuellerTag <= SONNTAG; aktuellerTag++)
-{...};</code>
+{...};</sxh>
 ++++Beispiel für Konstanten|
-|<fc #800000>**SCHLECHT**</fc>| <code c>
+{{tablelayout?tableSort=1&tableSearch=1}}
+|<fc #800000>**SCHLECHT**</fc>| <sxh c; first-line: 1>
 // Konstanten
@@ Zeile 172: / Zeile 173: @@
 ...
-</code>       |
+</sxh>      |
-|<fc #008000>**GUT**</fc>| <code c>
+|<fc #008000>**GUT**</fc>| <sxh c; first-line: 1>
 // Konstanten
@@ Zeile 193: / Zeile 194: @@
 ...
-</code>       |
+</sxh>      |
 ++++
@@ Zeile 203: / Zeile 204: @@
   * Variablen beginnen mit Kleinbuchstaben.
   * Falls Sie aus mehreren Wörtern zusammengefügt sind, so werden die folgenden Wörter **ohne Unterstrich**  direkt angefügt, aber groß geschrieben. Dies wird auch als "BinnenMajuskel" oder "camelCase" bezeichnet.
-  * Vermeiden Sie zu allgemeine Namen, wie anzahl, uebergabewert oder string. Sinnvoller sind Namen, wie anzahlBuchstaben, stunden, ausgabeString. Durch die Autovervollständigung (Vorschläge unter dem eingegebenen Text) sind auch längere Namen schnell einzugeben, bzw mit Cursortasten und TAB auswählbar.
+  * Vermeiden Sie zu allgemeine Namen, wie anzahl, uebergabewert oder string. Sinnvoller sind Namen, wie ''anzahlBuchstaben'', ''stunden'', ''ausgabeString''. Durch die Autovervollständigung (Vorschläge unter dem eingegebenen Text) sind auch längere Namen schnell einzugeben, bzw. mit Cursortasten und TAB auswählbar.
   * 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. ''int a;''.
-  * 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 ''bool a=1;''.
 ++++Beispiel für Variablen|
-|<fc #800000>**SCHLECHT**</fc>| <code c>
+|<fc #800000>**SCHLECHT**</fc>| <sxh c; first-line: 1>
 // Variablen
@@ Zeile 220: / Zeile 221: @@
 char    wasKopie2;         // unklar,Was was ist
-</code>       |
+</sxh>      |
-|<fc #008000>**GUT**</fc>| <code c>
+|<fc #008000>**GUT**</fc>| <sxh c; first-line: 1>
 // Variablen
@@ Zeile 229: / Zeile 230: @@
 bool            zeichenAusgabe  = 1;    // Wahrheitswert zur Anzeige, ob
                                         // ein Zeichen ausgegeben werden darf
-</code>       |
+</sxh>      |
 ++++
@@ 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.
-  * 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. ''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 include't).
-  * Nutzen Sie den Zeileneinschub den AtmelStudio automatisch anbietet.
+  * Nutzen Sie den Zeileneinschub den Microchip Studio automatisch anbietet.
-  * 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. ''if (isI2cMessageNotSent()) sentI2cMessage()''
+  * 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. ''if (isI2cMessageNotSent()) sentI2cMessage()''
   * Vermeiden Sie zu viele Leerzeilen.
   * Stellen Sie auch jeder Funktion eine kurze Beschreibung voran. Aus dieser sollte hervorgehen, was Sinn und Zweck der Funktion ist.
 ++++Beispiel für Anweisungsblöcke|
-|<fc #800000>**SCHLECHT**</fc>| <code c>
+|<fc #800000>**SCHLECHT**</fc>| <sxh c; first-line: 1>
 uint8_t unter2_neu(uint8_t Was)
 {
@@ Zeile 259: / Zeile 260: @@
 return 0;
 }
-</code>       |
+</sxh>      |
-|<fc #008000>**GUT**</fc>| <code c>
+|<fc #008000>**GUT**</fc>| <sxh c; first-line: 1>
 uint8_t schluesselPositionFinden(uint8_t schluessel)
 /*    Das Array schluesselArray wird nach dem übergebenen Schlüssel durchsucht.
@@ Zeile 274: / Zeile 275: @@
     return 0;
 }
-</code>       In diesem Beispiel wäre der Funktionsname schluesselPosition statt schluesselPositionFinden auch geeignet gewesen.  \\ Weiterhin bietet es sich an hier auch einen Zeiger auf das Array und die Werte für erste und letzte Position als Parameter der Funktion zu übergeben, um diese flexibler anwenden zu können.  |
+</sxh>      In diesem Beispiel wäre der Funktionsname ''SchluesselPosition'' statt ''schluesselPositionFinden'' auch geeignet gewesen.  \\ Weiterhin bietet es sich an hier auch einen Zeiger auf das Array und die Werte für erste und letzte Position als Parameter der Funktion zu übergeben, um diese flexibler anwenden zu können.  |
 ++++
@@ Zeile 284: / Zeile 285: @@
 ++++Beispiel für Arrays, Schleifen und Abfragen|
-|<fc #800000>**SCHLECHT**</fc>| <code c>
+|<fc #800000>**SCHLECHT**</fc>| <sxh c; first-line: 1>
 #define MAX 10
@@ Zeile 295: / Zeile 296: @@
     };
-</code>       |
+</sxh>      |
-|<fc #008000>**GUT**</fc>| <code c>
+|<fc #008000>**GUT**</fc>| <sxh c; first-line: 1>
 #define MAX 10
@@ Zeile 307: / Zeile 308: @@
     };
-</code>    |
+</sxh>   |
 ++++
@@ Zeile 318: / Zeile 319: @@
 ++++Beispiel für ähnliche Zeilen|
-|<fc #800000>**SCHLECHT**</fc>| <code c>
+|<fc #800000>**SCHLECHT**</fc>| <sxh c; first-line: 1>
 ...
     temp = hunderter;
@@ Zeile 333: / Zeile 334: @@
 ...
-</code>       |
+</sxh>      |
-|<fc #008000>**GUT**</fc>| <code c>
+|<fc #008000>**GUT**</fc>| <sxh c; first-line: 1>
 #define ASCII_ZERO 0x30
 #define MOD_TEN 10
@@ Zeile 355: / Zeile 356: @@
     printDecimalDigit(DISP_LINE1, DISP_POS2, einer);
 ...
-</code>       |
+</sxh>      |
 ++++
@@ Zeile 364: / Zeile 365: @@
 ++++Beispiel für Verzweigungen 1 - Umwandlung in Array |
-|<fc #800000>**SCHLECHT**</fc>| <code c>
+|<fc #800000>**SCHLECHT**</fc>| <sxh c; first-line: 1>
 ...
     if (i==0) output("null");    // wenn 0 dann null
@@ Zeile 374: / Zeile 375: @@
 ...
-</code>       |
+</sxh>      |
-|<fc #008000>**GUT**</fc>| <code c>
+|<fc #008000>**GUT**</fc>| <sxh c; first-line: 1>
 #define MAX_ANZ_AUSGABE 6
 #define MAX_ZEICHEN_AUSGABE 4
@@ Zeile 391: / Zeile 392: @@
     outputToLCD(AusgabeZahl[i]);
 ...
-</code>       |
+</sxh>      |
 ++++++++Beispiel für Verzweigungen 2 - Umwandlung in Switch-Case|
-|<fc #800000>**SCHLECHT**</fc>| <code c>
+|<fc #800000>**SCHLECHT**</fc>| <sxh c; first-line: 1>
 ...
     if (i==0) doZero;    // wenn 0 dann null
@@ Zeile 405: / Zeile 406: @@
 ...
-</code>       |
+</sxh>      |
-|<fc #008000>**GUT**</fc>| <code c>
+|<fc #008000>**GUT**</fc>| <sxh c; first-line: 1>
 ...
     switch(i) {
@@ Zeile 417: / Zeile 418: @@
     };
 ...
-</code>       |
+</sxh>      |
 ++++++++Beispiel für Verzweigungen 3 - Optimierung von Switch-Case|
-|<fc #800000>**OPTIMIERBAR**</fc>| <code c>
+|<fc #800000>**OPTIMIERBAR**</fc>| <sxh c; first-line: 1>
 ...
     switch(i) {
@@ Zeile 437: / Zeile 438: @@
 ...
-</code>       |
+</sxh>      |
-|<fc #008000>**BESSER**</fc>| <code c>
+|<fc #008000>**BESSER**</fc>| <sxh c; first-line: 1>
 ...
     switch(i) {
-        case 1, 2, 6...9 : doOne;   break;    // Einzelne Zahlen können mit Komma getrennt und Gruppen mit '...' kombiniert werden
+        case 1:
-        case 3:            doThree;           // ohne Break werden alle folgenden Befehle bis zum nächsten Break ausgeführt
+        case 2:                               // Einzelne Zahlen können mit case's untereinander ...
+        case 6 ... 9:      doOne;   break;    // ... und Gruppen mit '...' kombiniert werden
+        case 3:            doThree;           // Ohne Break werden alle folgenden Befehle bis zum nächsten Break ausgeführt
         case 4:            doFour;
         case 5:            doFive;
@@ Zeile 448: / Zeile 451: @@
     };
 ...
-</code>       |
+</sxh>      |
 ++++++++Beispiel für Verzweigungen 4 - Umwandlung in For-Next|
-|<fc #800000>**SCHLECHT**</fc>| <code c>
+|<fc #800000>**SCHLECHT**</fc>| <sxh c; first-line: 1>
 ...
     if (( 0<i) && (i<= 7)) j=j+2;
@@ Zeile 462: / Zeile 465: @@
 ...
-</code>       |
+</sxh>      |
-|<fc #008000>**GUT**</fc>| <code c>
+|<fc #008000>**GUT**</fc>| <sxh c; first-line: 1>
 ...
     int maxSteps            = 6;
@@ Zeile 473: / Zeile 476: @@
     };
 ...
-</code>       |
+</sxh>      |
 ++++
@@ Zeile 480: / Zeile 483: @@
 ++++Beispiel für Verzweigungen 4 - Verwenden von Else if|
-|<fc #800000>**SCHLECHT**</fc>| <code c>
+|<fc #800000>**SCHLECHT**</fc>| <sxh c; first-line: 1>
 ...
     if (( 0<i) && (i<= 7)) j=j+2;
@@ Zeile 490: / Zeile 493: @@
 ...
-</code>       |
+</sxh>      |
-|<fc #008000>**GUT**</fc>| <code c>
+|<fc #008000>**GUT**</fc>| <sxh c; first-line: 1>
 ...
     if      (( 0<i) && (i<= 7)) { j = j + 2;}
@@ Zeile 500: / Zeile 503: @@
     else if ((12<i) && (i<=20)) { j = j + 3;};
 ...
-</code>       |
+</sxh>      |
 ++++++++Beispiel für Verzweigungen 5 - Reduzieren der Anweisungen|
-|<fc #800000>**SCHLECHT**</fc>| <code c>
+|<fc #800000>**SCHLECHT**</fc>| <sxh c; first-line: 1>
 ...
     if      (i<=7) {
@@ Zeile 522: / Zeile 525: @@
 ...
-</code>       |
+</sxh>      |
-|<fc #008000>**GUT**</fc>| \\ noch leserlich: \\ <code c>
+|<fc #008000>**GUT**</fc>| \\ noch leserlich: \\ <sxh c; first-line: 1>
 ...
     if      (i<=7) {
@@ Zeile 538: / Zeile 541: @@
     DoOne;
 ...
-</code>        auch möglich, aber etwas schwerer leserlich:  <code c>
+</sxh>       auch möglich, aber etwas schwerer leserlich:  <sxh c; first-line: 1>
 ...
     if           (i<=7)              j=j+2;
@@ Zeile 547: / Zeile 550: @@
     DoOne;
 ...
-</code>     |
+</sxh>    |
 ++++
@@ Zeile 556: / Zeile 559: @@
 ++++Beispiel für Schleifen 1 - main()|
-|<fc #800000>**SCHLECHT**</fc>| <code c>
+|<fc #800000>**SCHLECHT**</fc>| <sxh c; first-line: 1>
 void main()
 {
@@ Zeile 568: / Zeile 571: @@
 }
-</code>       |
+</sxh>      |
-|<fc #008000>**GUT**</fc>| <code c>
+|<fc #008000>**GUT**</fc>| <sxh c; first-line: 1>
 void main()
 {
@@ Zeile 585: / Zeile 588: @@
 }
-</code>       |
+</sxh>      |
 ++++++++Beispiel für Schleifen 2 - Abbrechen von verschachtelten Schleifen|
-|<fc #800000>**SCHLECHT**</fc>| <code c>
+|<fc #800000>**SCHLECHT**</fc>| <sxh c; first-line: 1>
     for(int xpos=0;xpos<10;xpos++){
         initYPos;
@@ Zeile 601: / Zeile 604: @@
 ...
-</code>       |
+</sxh>      |
-|<fc #008000>**GUT**</fc>| <code c>
+|<fc #008000>**GUT**</fc>| <sxh c; first-line: 1>
     int xposMax=10, yposMax=20;
@@ Zeile 617: / Zeile 620: @@
 ...
-</code>       **Beachten Sie, dass in diesem Fall CancelButton eine Variable sein muss und sich zwischen den beiden if-Bedingungen nicht ändern darf (z.B. durch Interrupts).**     |
+</sxh>      **Beachten Sie, dass in diesem Fall CancelButton eine Variable sein muss und sich zwischen den beiden if-Bedingungen nicht ändern darf (z.B. durch Interrupts).**     |
 ++++
-  * _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 auslösen.
+  * _delay_ms() und _delay_us() sind zu 99% nicht notwendig. Verwenden Sie stattdessen Interrupts, bzw. Timer. \\ Es sollten durch Interrupts Takte angelegt werden, z.B. takt10ms, takt100ms, takt1s welche nur im ''main()'' abgefragt werden.
+  * Häufig bietet es sich an, in den Takten dann auch Verzweigungen in einer Zustandsmaschine aufzubauen (z.B. mit Zustandsvariablen wie ''outputState'': ''<nowiki>switch(outputState) {case initOutput: outputState++; ... break; case startOutput: outputState++; ... break; }</nowiki>'').
   * Wenn Sie Zahlen in Variablen speichern und diese auch mathematisch weiterverwenden, so wandeln Sie diese Variable erst bei der Ausgabe in das ASCII-Format um.
 ++++Beispiel für Variablen mit Ausgabe|
-|<fc #800000>**SCHLECHT**</fc>| <code c>
+|<fc #800000>**SCHLECHT**</fc>| <sxh c; first-line: 1>
 ...
     Zahlenwert = (ADC_Wert/10)%10 + 0x30;
@@ Zeile 633: / Zeile 637: @@
 ...
-</code>       |
+</sxh>      |
-|<fc #008000>**GUT**</fc>| <code c>
+|<fc #008000>**GUT**</fc>| <sxh c; first-line: 1>
 #define ASCII_ZERO 0x30
@@ Zeile 645: / Zeile 649: @@
     LCD_putc(Laengen[i]+ ASCII_ZERO);
 ...
-</code>   |
+</sxh>  |
 ++++
@@ Zeile 651: / Zeile 655: @@
 ====== Bewertung ======
-Zur Bewertung lege ich {{checkliste_250520.pdf|diese Checkliste}}  ({{checkliste_250520.xlsx|xls-File}} ) als Maßstab an.
+Zur Bewertung lege ich {{microcontrollertechnik:bewertung_ss24_prj99.xlsx|diese Checkliste (xls-File)}} als Maßstab an.