www.mikrocontroller.net

Forum: Compiler & IDEs Regeln für die Bezeichnungen von Variablen, Funktionen,.


Autor: Programmierer (Gast)
Datum:

Bewertung
0 lesenswert
nicht lesenswert
Hallo,
ich möchte gerne ein größeres Softwareprojekt professionel aufziehen und 
wollte fragen, ob es allgemeingültige Regeln gibt,
wie man am geschicktesten Variablen, Funktionen.. bezeichnet.

Gibt es irgendwo ne Übersicht, oder steht in einer schlauen Softwarenorm 
was dazu?

Wie bezeichnet ihr, deutsch oder englisch?

Vielen Dank

Autor: Falk Brunner (falk)
Datum:

Bewertung
0 lesenswert
nicht lesenswert
@  Programmierer (Gast)

>ich möchte gerne ein größeres Softwareprojekt professionel aufziehen und
>wollte fragen, ob es allgemeingültige Regeln gibt,
>wie man am geschicktesten Variablen, Funktionen.. bezeichnet.

Jain. Google mal nach Coding style etc.

>Gibt es irgendwo ne Übersicht, oder steht in einer schlauen Softwarenorm
>was dazu?

Keine Ahnung.

>Wie bezeichnet ihr, deutsch oder englisch?

Meist englisch.

MfG
Falk

Autor: Falk Brunner (falk)
Datum:

Bewertung
0 lesenswert
nicht lesenswert

Autor: thorstendb (Gast)
Datum:

Bewertung
0 lesenswert
nicht lesenswert
würde sagen, die wichtigsten Punkte sind:
#ifndef __HEADER_FILE_NAME__
#define __HEADER_FILE_NAME__
...
#endif

#define IN_GROSSBUCHSTABEN       // Caps mit underline

int FunktionsName(int param);    // "grosses" CamelCase

char varName;                    // "kleines" camelCase

- Kommentare wenn nötig
- selbstbeschriebende Funktions- und Variablennanem (erspart einem 
100000 Kommentare)
- Variablen wie i, j, k für übersichtliche schleifen
- Variablen wie x, y, z für Positionen
- bei arrays z.B. array[i] oder array[index] verwenden

- Eine Funktion nicht grösser als eine Bildschirmseite (lesbarkeit)
- Wiederverwendbarkeit, keine doppelten codeteile, für Geschwindigkeit 
notfalls inline verwenden
- kurze & knackige berechnungen, keinen spaghetticode
- ?: - Operator nur bei kompakten Ausdrücken verwenden, sonst if/else


So mal schnell zusammengefasst.


VG,
/th.

Antwort schreiben

Die Angabe einer E-Mail-Adresse ist freiwillig. Wenn Sie automatisch per E-Mail über Antworten auf Ihren Beitrag informiert werden möchten, melden Sie sich bitte an.

Wichtige Regeln - erst lesen, dann posten!

  • Groß- und Kleinschreibung verwenden
  • Längeren Sourcecode nicht im Text einfügen, sondern als Dateianhang

Formatierung (mehr Informationen...)

  • [c]C-Code[/c]
  • [avrasm]AVR-Assembler-Code[/avrasm]
  • [code]Code in anderen Sprachen, ASCII-Zeichnungen[/code]
  • [math]Formel in LaTeX-Syntax[/math]
  • [[Titel]] - Link zu Artikel
  • Verweis auf anderen Beitrag einfügen: Rechtsklick auf Beitragstitel,
    "Adresse kopieren", und in den Text einfügen




Bild automatisch verkleinern, falls nötig
Bitte das JPG-Format nur für Fotos und Scans verwenden!
Zeichnungen und Screenshots im PNG- oder
GIF-Format hochladen. Siehe Bildformate.
Hinweis: der ursprüngliche Beitrag ist mehr als 6 Monate alt.
Bitte hier nur auf die ursprüngliche Frage antworten,
für neue Fragen einen neuen Beitrag erstellen.

Mit dem Abschicken bestätigst du, die Nutzungsbedingungen anzuerkennen.