Ship-Simu Project

Hier fange ich mal an, die noch nicht oeffentlich genannten Coding-Guidelines fuer alle auf das Core-Projekt aufbauende Projekte zu schreiben.

Copyright / Urheberrechte:

- Es ist ein gemeinsames Copyright vereinbart, wobei das jeweilige Projekteentwicklerteam als Urheber eingesetzt wird. Dies hat ausschliesslich in dem Klassenheader-Tag etwas zu suchen (also dem Dokumentationstag oberhalb der Klassendefinition).

- Es koennen somit nicht pro Methode oder gar eingesandtes Patch Urheberrechte verlangt werden. Ein/zwei/n-mehr @author-Tag pro Methode ist jedoch willkommen. Mehr dazu weiter unten.

- Das gemeinsame Copyright dient dem Ausdruck, dass etwas fuer das Projekt und nicht fuer mich oder jemand anderes geschrieben wurde.

Verwendete Dokumentationstags:
Fuer Klassen und Methoden:

- @author = Wer dies geschrieben hat, es wird ausschliesslich der vollstaendige, echte Name (zusaetzlicher Nickname ist okay) mit gueltiger, fester Email-Adresse hier hingeschrieben. Zeilen wie "Copyright (c) 2011, by C00l Scripting-Guy" oder gar "By www.some-advert-link.example" sind unerwuenscht und fuehren zur Ablehnung des gesamten Patches. Dieser Tag kann sowohl in Klassenkoepfen, als auch Methodenkoepfen verwendet werden.

- @deprecated = Falls eine Klasse/Exception oder Interface oder Methode nicht mehr verwendet werden soll, da es eine neue Version gibt. Meistens ist dann folgende Tag mit verwendet:

- @see = Querverweis auf eine Klasse oder Methode, z.B. mit @deprecated zusammen verwendet.

Nur fuer Klassen:

- @todo = Kurzer Hinweis, was hier noch zu erledigen ist. Z.B. ist auch 0% done okay. Dieser Tag kann sowohl in Klassenkoepfen, als auch Methodenkoepfen verwendet werden.

- @version = Versionsnummer des gesamten Programmes, ausgenommen sind hier eventuelle Bibliotheken von Drittanbietern, da diese Dateien wegen spaeteren Updates nicht geaendert werden; wird ausschliesslich im Klassenkopf verwendet.

- @copyright = Der projektgemeinsame Urheberrechtshinweis, mehr dazu weiter oben; wird ausschliesslich im Klassenkopf verwendet.

- @license = Die projektweit vewendete Lizenz, ausgenommen sind wieder Bibliotheken von Drittanbietern. Diese ist meistens GNU GPL v3 or any newer version; wird ausschliesslich im Klassenkopf verwendet.

- @link = URL zur Projektseite, falls keine eigene Projektseite vorhanden ist, wird ship-simu.org verlinkt (da der Core von hier kommt).; wird ausschliesslich im Klassenkopf verwendet.

Nur fuer Methoden:

- @return = Rueckgabewert der Methode, oder void falls kein return-Kommando am Ende der Methode steht (mehr zum Code-Aufbau weiter unten)

- @param = Variablenname und eine kurze Beschreibung, keinen Variablentyp, da dies mit Doxygen geparst wird

- @throws = Name der Exception, die in ausschliesslich dieser Methode gewerfen werden kann (siehe z.B. die execute()-Methode vieler Filter-Klassen).

Allgemeiner Codeaufbau:

- Mehr folgt hier spaeter. Sorry, wird langsam spaet!