Kommentare

Hi.

Ich habe da mal eine Frage... :-) Unswar würde ich euch darum gerne bitten mir zu sagen, wie ich mit Kommentaren umgehen soll. Wie macht man es in Software-Firmen. Wenn ich einen Code anfange zu schreiben.. was sollte dann am Anfang da stehen. Author:... Datum:.... Programmname:.... etc?? Bitte sagt mir was alles in dieser Beschreibung einkommentiert werden sollte.

Wie soll ich desweiteren im Code mit den Kommentaren arbeiten. Welche sind da sinnlos und welche hilfrecih.

Danke euch schon mal sehr im vorraus...

Cya James

 

Was meinst du mit "nebenbei mithelfen"? Irgendwer kommt vorbei und schreibt mal schnell irgendein paar Zeilen um? -> ganz schlecht! So verliert man mit Garantie sehr bald den Überblick. Jeder sollte nur "seinen" Quelltext für "seinen" Programmteil ändern - und zwar nur höchst persönlich. Sonst ist immer jemand anderes Schuld wenn was nicht funzt - und keiner kennt sich wirklich aus

So schauen meine Kommetare (ungefähr ) aus

 

Hi... was meinst du mit Changlog?? Und wenn ich, dass Programm mit anderen programmiert habe, die aber nur nebenbei mitgeholfen haben... wie notiere ich die dann im der Beschreibung oben?

Danke für die Hilfe :-)

 

Ich denke da hat jede Firma ihren eigenen "Standard".
Mindestens sollte man IMHO den eigenen Namen, das Kompilations/Implementations-Datum, eine Versionsnummer (SEHR hilfreich, wenn es was "größeres" ist) und eine kurze Funktionsbeschreibung (Was macht das Proggy/Modul/Bibliothek und braucht es irgendwelche ausgefallenen Bibliotheken oder Compilerschalter) einbauen.
Zusätzlich könnte man noch eine Art kurzes Changelog zur vorangegangenen Code-Version einfügen.

Im Code selbst bin ich mit Kommentaren eher sparsam. Maximal ein oder zwei Zeilen zu komplexeren Methoden. Hat aber auch damit zu tun, dass ich versuche, möglichst sprechende Namen für die Variablen und Methoden zu verwenden.