Coding Stylesheet

Halpha

Erfahrenes Mitglied
Hallo,

ich möchte bald ein größeres Web Projekt aufbauen und da werden mit Sicherheit einige Programmierer daran arbeiten.

Jetzt möchte ich mir ein Coding Stylesheet schreiben in dem bis aufs letzte Komma definiert ist wie etwas geschrieben gehört, damit der Code egal von welchem Coder gleich aussieht.

Nur leider hab ich sowas noch nie gemacht, darum die Frage, weiß jemand wie man das am besten aufbaut, womit man anfängt und mit was man das am besten macht, einem Wiki? oder ne Statische Html Seite mit Navi Punkten?

Danke schon mal
 
Hallo Michael,

ein sehr wichtiger Punkt bei einem solchen Styleguide ist die schnelle und unkomplizierte Verfügbarkeit. Wenn man die Regeln noch nicht verinnerlicht hat, muss man sehr oft „spicken“, was einen unweigerlich aus dem Programmierfluss bringt. Diese Unterbrechungen sollten darum so kurz wie möglich ausfallen.

Mein Vorschlag wäre daher eine einzelne HTML- oder PDF-Datei, die in die Versionsverwaltung eingecheckt wird und somit für jeden Programmierer stets lokal verfügbar ist. Inhaltlich sollte der Styleguide klar strukturiert sein, damit man schnell findet, wonach man gerade sucht. Zu jedem Punkt sollte wenn möglich ein Negativ- und ein Positivbeispiel angegeben sein (Beispiele sagen oft mehr als tausend Worte). Unmissverständliche Formulierungen sind natürlich auch Pflicht. Daher den Styleguide am Besten mehrmals gegenlesen lassen oder gleich im Team erarbeiten.

Zur Erzeugung könntest du z.B. Docutils oder DocBook verwenden.

Zum Abschluss noch ein Beispiel für einen meiner Meinung nach sehr guten Styleguide: Google C++ Style Guide

Grüße,
Matthias
 

Halpha

Erfahrenes Mitglied
Ok danke für den ausführlichen Beitrag;)
Ich hab mich jetzt mit meinem Team geeinigt wir nutzen dafür ein wiki, da werden wir dann auch alle Funktionen und sowas definieren.

Fällt euch noch etwas ein was man festlegen sollte, bis jetzt haben wir:

Kommentare,
Strings,
Einrückungen,
Klammern,
Anführungszeichen,
Funktionsnamen,
Klassennamen,
Variablen,

lg

Michael
Datenbank(Name, struktur, präfix)