CloudImagesAreTheBest / VendingMachineC

Schulprojekt "Getränkeautomat" in Anwendungsentwicklung. Abgabe: Mittwoch, den 28. Februar 2018
3 stars 1 forks source link

Dokumentations-/Formatvorlage; Code-Konventionen #15

Closed CloudImagesAreTheBest closed 6 years ago

CloudImagesAreTheBest commented 6 years ago

Anlegen einer Dokumentenvorlagen, Verwendung von Code-Konventionen

Warum?

Falls in einer unsere Dokumente mal gearbeitet wird, wäre es von Vorteil wenn auch die gleichen Formatierungen und "Schreibstile" verwendet werden - so wird eine einheitliche und schöne Dokumentation gewährleistet.

Vorschläge

Wer schon ungefähr eine Vorstellung hat, wie unsere Dokumente auszusehen haben, kann dies gerne als Kommentar unter diesem Issue erfassen. :-)

Code-Konventionen

Auch hier sollten wir darauf achten einheitliche Programmierstile zu verwenden, u.a. würden Fragen im Raum stehen wie z.B. ungarische Notation, Setzen von Entwicklerkürzel bei Änderungen etc..

Auch hier könnt ihr Vorschläge in Form eines Kommentars machen

Edit 02.02.2018 13:02:

Ich mache dann aus den Abstimmungen eine Formatvorlage fertig, die dementsprechend auf unsere Dokumente angewandt werden kann