Code richtig bereitstellen?
Ich hätte zum Thema "Clean-Code & mehr" im Front-End & Back-End einige Fragen.
Hauptsächlich zum Thema Webentwicklung in HTML, SASS, JavaScript, PHP.
- Wie kommentiert ihr?
- In welcher Sprache (Deutsch, Englisch) kommentiert ihr?
- Macht ihr Minfy?
- Schreibt ihr zusätzliche Hinweise in den Code wie Version und Autor?
- Nutzt ihr CSS, SCSS oder SASS?
- Habt ihr Probleme mit Legacy-Code?
Vielen Dank im Voraus!
6 Antworten
Wie kommentiert ihr?
Wenn Kommentare, dann nur für den rechtlichen Aspekt. Alles andere sind Bloater.
Kommentare sind kein Ersatz für guten Code.
Macht ihr Minfy?
Nein.
Schreibt ihr zusätzliche Hinweise in den Code wie Version und Autor?
Dafür gibt es Version Control Systeme.
Nutzt ihr CSS, SCSS oder SASS?
CSS, wenn ich mal in der Webentwicklung unterwegs bin.
Habt ihr Probleme mit Legacy-Code?
Die alte Schule ist damit aufgewachsen - somit, nö.
Zu 1: Es gibt unterschiedliche Kommentare, einmal generell sowie Notizen für mich selbst. Ich benutze für letztere die Erweiterung Better Comments, damit derlei Kommentare auch visuell leichter an ihrer Relevanz zu erkennen sind.
Zu 2: Ich selber kommentiere ausschließlich in Englisch, sei den es gibt gesonderte Vorgaben und Vereinbarung, dass jene in Deutsch geschrieben werden sollen. Ansonsten jedoch Kommentare, Funktionen, Klassen etc. alles in Englisch.
Zu 3: Ja, geschieht automatisch und hängt auch mit vom jeweiligen Stack ab.
Zu 4: Hängt vom Projekt und System ab, wobei Versionsnummern bereits in Build-Tools automatisch mit Hash angehängt werden. Kommt aber durchaus vor, dass es gesondert kommentiert wird. Ansonsten ohnehin alles via Git/GitHub.
Zu 5: Wenn ich alleine an Projekten arbeite, teilweise Sass und Pug einsetze. Inzwischen jedoch primär SCSS schreibe oder mit Nested CSS arbeite. Hängt meist von der Projektgröße sowie eingesetzten Frameworks und Bibliotheken ab.
Zu 6: Nein, nicht wirklich.
Ich nutze nicht PHP oder JS fürs Back-end sondern C#, aber es geht hier ja nicht um die Sprache.
- Klassen und Methode dokumentiere ich schon außer es ist nur ein sehr kleines Model. Mitten im Code dokumentiere ich recht selten. Das mach ich nur wenn es sich entweder um Dinge handelt wie Komplexe abfragen oder etwas dessen Funktion allein aus dem Code nicht ersichtlich ist.
- Immer auf Englisch.
- Ja. Der Server stellt auch nur die Minified Version bereit.
- Nein, dafür nutze ich Git.
- Da ich wenn es geht immer Bootstrap Features nutze kommt das sehr selten zum Einsatz, aber wenn, dann CSS, weil es nur sehr wenig ist.
- Nein.
Ich mach das aber nur als Hobby und nicht als Beruf.
Wie kommentiert ihr?
Das was nachfolgende Codeblöcke bewirken.
In welcher Sprache
deutsch.
Macht ihr Minfy?
Nein.
Schreibt ihr zusätzliche Hinweise in den Code wie Version und Autor?
Nein.
Nutzt ihr CSS, SCSS oder SASS?
Nur CSS.
Habt ihr Probleme mit Legacy-Code?
Nein.
Disclaimer: Ich behaupte nicht, dass mein Vorgehen perfekt ist oder Vorbildfunktion hat.
Alex
also, grundstätzliche nutze ich diese pretty format einstllung oder wie die heißt. ansonsten kommentare in englisch und docstrings für funktionen. version autor ist mir total egal. ich nutzte meist scss wenns geht. 6 nein