heise online · c't · iX · Technology Review · Telepolis · mobil · Security · Netze · heise open · heise resale · Autos · c't-TV · Jobs · Kiosk
Zum Inhalt
c't

c't Projekte - c't-Bot und c't-Sim - Mailinglisten

c't-Bot und c't-Sim


[Voriger (Datum)] [Nächster (Datum)] [Voriger (Thread)] [Nächster (Thread)]
[Nach Datum][Nach Thread]

[ct-bot] Coding-Style

Absender: Benjamin Benz
Datum: Sa, 18.03.2006 13:43:54


Hallo,

Für Patches, die ins offizielle Repository einfließen sollen, hier ein paar 
Coding-Regeln. Sicherlich ist der Programmierstil Geschmackssache, aber ein 
halbwegs einheitlicher Code erleichtert das Lesen:

* Variablen, Konstanten, Funktionen und alles, was direkt mit dem Quellcode zu 
tun hat, sollten rein englisch sein; Kommentare und Dokumentation dagegen auf 
Deutsch verfasst werden. 

* Bitte benutzen Sie hierbei keine Umlaute, da diese von Windows, Linux, Mac, 
Solaris, usw. unterschiedlich gehandhabt werden und sonst bald nur noch als 
Zeichensalat in der Codebasis auftauchen.

* Funktionen bitte vollständig Doxygen- bzw. Javadoc-Konform kommentieren

* Für Verhalten gilt:

Verhalten, die vom Framework bearbeitet werden heißen:

bot_xxx_behaviour

Die Botenfunktionen, die sie aufrufen/aktivieren heißen

bot_xxx

also z.B.

bot_drive_distance_behaviour()
und
bot_drive_distance();

P.S. Leider hält der Code im Moment diese Regeln nicht überall ein. Wir 
arbeiten aber daran, ihn zu bereinigen.
--
Benjamin Benz
c't-Magazin
Heise Zeitschriften Verlag
bbe@xxxxxxxx



Copyright © 2007 Heise Zeitschriften Verlag Kritik, Anregungen bitte an c't-WWW Datenschutzhinweis   Impressum