Home - PhilippSchick/Prog2Groupwork GitHub Wiki

Ein paar Konventionen zur Dokumentation und Arbeit mit Git:

  • Kommentare immer auf Englisch
  • .java Dateien mit Eclipse Auto-Format (strg + shift + f) Formatieren
  • Die in Java üblichen Standards für Kommentare einhalten (Vergl. Oracle: Format of a Doc Comment)
  • Jede Methode Kommentieren
  • Änderungen in kleinen Schritten Commiten (am besten nach jeder fertigen Methode)
  • Commits auf Englisch Kommentieren
  • Neue Methoden, Attribute oder Klassen im Klassendiagramm einzeichnen
Durch diese Standards sollte es jedem leicht fallen den Code von anderen zu verstehen
⚠️ **GitHub.com Fallback** ⚠️