|
|
|
weitere Literatur zu Coding Standards? |
|
| Markuso |
Gast
|
 |
Beiträge: ---
|
|
|
|
Anmeldedatum: ---
|
|
|
|
Wohnort: ---
|
|
|
|
Version: ---
|
|
|
|
 |
|
Verfasst am: 13.06.2012, 14:06
Titel: weitere Literatur zu Coding Standards?
|
 |
Hallo,
ich bin interessiert an einem "Standard" für Code-Formatierung.
D.h wie wird z.B. bei for schleifen eingerückt... danach... tab, leerzeichen....
Wann wie verwendet man Leerzeilen.... Variablen-Bezeichnungen...
Da gibt es bestimmt irgendwelche unterschiedlichen Konventionen? z.B. beim Linux-Kernel glaub ich hat sich mal wer beschwert, dass bei neuen patches solche guidelines nicht beachtet wurden...
gut ich weiß, die Geschmäcker sind verschieden, aber generell würde ich sowas mal ganz interessant finden, im Hinblick auf Zusammenarbeit / Austausch von Code...
kennt da noch wer andere Infomaterial zusätzlich zu
Richie Cotton's guide: http://4dpiecharts.com/matlab-code-style-guide/
Richard Johnson's guide: http://www.mathworks.com/matlabcentral/fileexchange/2529
David Schwartz's guide: http://www.cs.cornell.edu/courses/cs99/2002fa/matlabstyle.html
Markuso
|
|
|
|
|
|
| flashpixx |
Forum-Guru
|
|
Beiträge: 355
|
|
|
|
Anmeldedatum: 19.04.08
|
|
|
|
Wohnort: ---
|
|
|
|
Version: ---
|
|
|
|
|
|
|
Verfasst am: 13.06.2012, 15:03
Titel:
|
|
| |
 |
 |
Also ich nutze keine Tabs, sondern Leerzeichen (1 Tab = 4 Leerzeichen), denn gerade bei Python kann das sonst zu richtig fiesen Fehlern führen.
Weiterhin sind bei mir generell alle Codes UTF-8 um cross-plattform ohne Probleme arbeiten zu können.
Ich verwende eine Art http://de.wikipedia.org/wiki/Ungarische_Notation für die Bezeichnung, wobei ich folgendes bei der Bezeichnung von Variablen mache:
[l | m | p | r][x|n|c|..]Name
Das erste Zeichen gibt den Scope der Variablen an, l=lokal, m=Member, r = Rückgabe und p=Parameter, bei Sprachen, die eine statische Typenbindung haben (wie z.B. C++) fällt das zweite Zeichen weg, bei nicht statischen Typenbindungen eben wie in der Ungarischen Notation beschrieben und dann der Name als "CamelCase". Z.B. ein CellArray bekommt als zweiten Präfix ein "a" für Array, ein Struct ein "x"
Die Einrückungen entsprechend bei Klammern z.B.
Dokumentation komplett mit Hilfe von http://de.wikipedia.org/wiki/Doxygen
Da ich in mehreren Sprache entwickle halte ich dieses System so weit wie möglich konsistent, darum ist die Antwort auch nicht Matlab bezogen 
Bisher klappt das sehr gut. Gerade die Dokumentation wird überhalb der Funktion mit Doxygen durchgeführt und dann unterhalb von function die Userhilfe. Generell verwende ich Englisch zur Kommentierung. Zur Codeverwaltung benutze ich ein Subversion, wobei dann automatisch die Version in die Quellcodedateien eingefügt wird.
|
|
|
|
|
|
|
Einstellungen und Berechtigungen
|
|
Du kannst Beiträge in dieses Forum schreiben.
Du kannst auf Beiträge in diesem Forum antworten.
Du kannst deine Beiträge in diesem Forum nicht bearbeiten.
Du kannst deine Beiträge in diesem Forum nicht löschen.
Du kannst an Umfragen in diesem Forum nicht mitmachen.
Du kannst Dateien in diesem Forum posten
Du kannst Dateien in diesem Forum herunterladen
|
|
Impressum
| Nutzungsbedingungen
| Datenschutz
| FAQ
|  RSS
Hosted by:
Copyright © 2007 - 2025
goMatlab.de | Dies ist keine offizielle Website der Firma The Mathworks
MATLAB, Simulink, Stateflow, Handle Graphics, Real-Time Workshop, SimBiology, SimHydraulics, SimEvents, and xPC TargetBox are registered trademarks and The MathWorks, the L-shaped membrane logo, and Embedded MATLAB are trademarks of The MathWorks, Inc.
|
|
