neradis/index-vivus

Wiki Seite mit coding convetions erstellen

Closed this issue · 1 comments

Bereits zum Beginn des Projektes sollten wir uns alle bemühen, unseren Code in einem einheitlichen Stil zu schreiben, Damit beim späteren merges nicht unnötig viel Zeit in die Vereinheitlichung von der Wahl von Bezeichnern (z.B. CamelCase vs. lowerCamelCase vs. snake_case vs. ALL_CAPS usw.), Tabulatoren u. Ä. investieren müssen.

Ideal wäre wohl, wenn der Bearbeiter dieser Aufgabe aus dem Netz jeweils einen ausführlicheren Style-Guide für Java und für Ruby heraussucht. Diese gelten dann als Referenz, wenn man mal für Detailentscheidungen nachsehen will.

Zusätzlich sollten die wichtigsten Punkte der Styleguides kurz stichpunktartig auf der Wiki-Seite unseres Projekts zusammengefasst sein. Vor allem:

  • Umsetzung von tabs (hier waren wir ja eig. schon auf 4 spaces übereingekommen)
  • Welche Bezeichnerschreibweisen sollen für welche Sprachelemente benutzt werden (z.B. für Java: Klassennamen in CapitalizedCamelCase, public Konstanten in ALL_CAPS, aber private Konstanten in smallCamelCase, usw.)
  • für Java: Sollen Interfaces, Abstrakte Klassen und implementierende konkrete Klassen durch Namenskonventionen erkennbar gemacht werden? Wenn ja, durch welche?

Seite ist schon angelegt: https://github.com/neradis/index-vivus/wiki/Coding-Conventions

Allerdings noch recht spärlich mit Inhalt gefüllt.