@ErfinderDesRades
Kommentare zwischendurch da, wo sie nötig sind.
Wenn ich ein Projekt übernehme (und die beiden letzten dieser waren praktisch unkommentiert) fräse ich erst mal quer durch und formatiere den Code nach den neuen Vorschriften (@EDR: Da würdest Du Dich wohl im Grabe herum drehen,
Da werden grob Strukturen identifiziert, GUI, Hardware usw. initialisieren, Settings verwalten usw. und als solche kommentiert, meist nur ein Wort.
Da die XML-Kommentare bei HOver angezeigt werden, pflege ich die sehr, auch für private Prozeduren. Mit der Zeit kommt dann die Erkenntnis, was der Code wirklich tut, da werden die Kommentare präzisiert.
Mein Chef hat inzwischen eingesehen, dass die Kommentierung des Codes essenziell wichtig ist, weil hier eben zwei meiner Vorgänger ein Chaos hinterlassen haben.
Im Kommentar zum CheckIn der Sourcecodeverwaltung steht da eben manchmal einfach nur "Code aufgeräumt und kommentiert".
Aber die History.txt im Projekt wird ordentlich gepflegt, um dann schneller die Version vor einer Änderung zu finden.
Ja, es ist so. Der Haken im Projekt gehört zu den firmen-gegebenen Projekteinstellungen.jvbsl schrieb:
Und ich glaube @RodFromGermany meinte mit seinem Satz eben XML kommentare.
Kommentare zwischendurch da, wo sie nötig sind.
Wenn ich ein Projekt übernehme (und die beiden letzten dieser waren praktisch unkommentiert) fräse ich erst mal quer durch und formatiere den Code nach den neuen Vorschriften (@EDR: Da würdest Du Dich wohl im Grabe herum drehen,
{
und }
stehen da einzeln in einer Zeile). Die Forderung ist, dass das Codelayout aller Entwickler praktisch identisch aussehen soll.Da werden grob Strukturen identifiziert, GUI, Hardware usw. initialisieren, Settings verwalten usw. und als solche kommentiert, meist nur ein Wort.
Da die XML-Kommentare bei HOver angezeigt werden, pflege ich die sehr, auch für private Prozeduren. Mit der Zeit kommt dann die Erkenntnis, was der Code wirklich tut, da werden die Kommentare präzisiert.
Mein Chef hat inzwischen eingesehen, dass die Kommentierung des Codes essenziell wichtig ist, weil hier eben zwei meiner Vorgänger ein Chaos hinterlassen haben.
Im Kommentar zum CheckIn der Sourcecodeverwaltung steht da eben manchmal einfach nur "Code aufgeräumt und kommentiert".
Aber die History.txt im Projekt wird ordentlich gepflegt, um dann schneller die Version vor einer Änderung zu finden.
Falls Du diesen Code kopierst, achte auf die C&P-Bremse.
Jede einzelne Zeile Deines Programms, die Du nicht explizit getestet hast, ist falsch
Ein guter .NET-Snippetkonverter (der ist verfügbar).
Programmierfragen über PN / Konversation werden ignoriert!
Jede einzelne Zeile Deines Programms, die Du nicht explizit getestet hast, ist falsch
Ein guter .NET-Snippetkonverter (der ist verfügbar).
Programmierfragen über PN / Konversation werden ignoriert!