neradis / index-vivus

student project to present lexical knowledge from XML-transcriptions of dictionaries in an interactive web interface for easier lookup and explorative search
0 stars 0 forks source link

Wiki Seite mit coding convetions erstellen #4

Closed neradis closed 10 years ago

neradis commented 10 years ago

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:

andywer commented 10 years ago

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

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