Code richtig bereitstellen?

8 Antworten

Vom Beitragsersteller als hilfreich ausgezeichnet
medmonk
Von gutefrage auf Grund seines Wissens auf einem Fachgebiet ausgezeichneter Nutzer
Webentwicklung
18.08.2024, 20:27

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.
Woher ich das weiß:Berufserfahrung – Full-Stack Developer
GFernando
20.09.2024, 18:54
  1. Nur wenn z. B. der Name der Funktion oder Variable selbst nicht das hergibt, um was es gerade explizit geht (da er sonst zu lange wäre) oder wenn es Code gibt, der normalerweise anderes produziert werden würde, es aber Gründe gibt, dass dieser genau so dasteht. Ansonsten sind die Namen der Klassen, Methoden und Variablen selbstredend, jedoch so eindeutig und kurz wie möglich gehalten.
  2. Spanisch
  3. Was CSS und JS angeht, Ja (per Vite)
  4. Nein. Aber ich benutze GIT und dort haben die Commits aussagekräftige Bezeichnungen.
  5. CSS oder SCSS, je nach Komplexität
  6. Nein. Ich sehe immer zu, dass der Code mit der neuesten PHP-Version kompatibel ist und das Framework zumindest für eine aktuell gültige PHP-Version upgedated wurde. Versioning und Updaten sind wichtiger Bestandteil der Arbeit.
cleanercode
18.08.2024, 20:53
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ö.
Mirko Marek
Von gutefrage auf Grund seines Wissens auf einem Fachgebiet ausgezeichneter Nutzer
Mediengestalter Digital und Print
07.02.2025, 18:16

Hi jarko3,

auch wenn die Antworten sehr spät kommen, möchte ich darauf anntworten.

  1. Kommentare sollte man da gebrauchen, wo man davon ausgeht das man später Zeit brauch um den eigenen Code und deren Zweck wieder zu erkennen. Du darfst ruhig alles mit Kommentaren ausstatten. Es köpft dich niemand für Kommentare.
  2. Wenn du oder dein Team daran arbeitest und diese alle Deutsch sprechen, steht nichts dagegen auch auf Deutsch zu kommentieren.
  3. Minify lohnt sich erst wenn man eine bestimmte Menge an Code geschrieben hat und dadurch unnötig Traffic und Performance eingesparrt werden kann. Wenn du für eine Seite mal 300 Zeilen Code hast, muss man sich es wirklich überlegen ob sich das lohnt. Aber ja, das ist eine sehr gutes Mittel.
  4. Das mache ich sehr selten mit Author und Version. Die Versionierung wird bei mir durch Git und serverseitige Generierung der Seite erstellt.
  5. Beruflich nutze ich auch CSS-Tools wie Sass und Co. aber auch sehr viel CSS. Sass wird sowieso später in CSS umgewandelt. Es lohnt sich besonders wenn man große Projekte umsetzt und mit anderen zusammen arbeitet.
  6. Das kommt bei mir auch vor. Besonders wenn der Code über 10 Jahre alt ist und man nicht mehr genau weiß warum man es so gemacht hat. ECMAScript(JavaScript) und CSS haben sich in den letzten Jahren so weit entwickelt, das man viele Kundenprojekte überarbeiten müsste, weil man versucht hat mit unter anderem workarounds Probleme zu lösen, die es heute nicht mehr gibt. Das passiert aber nur mit Uralt-Code, der im Team geschrieben wurde. Wenn ich alleine Projekte umsetze, kommt das nicht vor.
Woher ich das weiß:Berufserfahrung – Ich bin gelernter Mediengestalter Digital und Print(IHK)
jarko3 
Beitragsersteller
 07.02.2025, 19:52

Vielen Dank, das hat mir tatsächlich weitergeholfen. Ich schätze auch eine Antwort nach so langer Zeit.
Suiram1
18.08.2024, 20:26

Ich nutze nicht PHP oder JS fürs Back-end sondern C#, aber es geht hier ja nicht um die Sprache.

  1. 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.
  2. Immer auf Englisch.
  3. Ja. Der Server stellt auch nur die Minified Version bereit.
  4. Nein, dafür nutze ich Git.
  5. 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.
  6. Nein.

Ich mach das aber nur als Hobby und nicht als Beruf.
Woher ich das weiß:Hobby – Ich programmiere seit 3 Jahren mit C#