Kommentierung

Hey Leute !
Da wir in der Schule daruaf gedrillt werden alles in einem Programm zu kommentiern, frage ich euch: Wie wichtig ist eine gute auskommentierung in großen Projekten ?
MfG pikachu25

Bei mir ist meistens die Dokumentation (in Zeilen) länger als das Programm. Edit: Achja, ich dachte zwar es sei offensichtlich, aber ich trenne Dokumentation und Programmcode.

Wenn viele Personen daran beteiligt sind sehr wichtig.
Stell dir vor jemand schreibt ein Part und du musst dann nochmal was dran ändern.
Bevor du mit der Arbeit beginnen kannst musst du den ganzen Code verstehen um überhaupt zu wissen wo du ansetzten musst.
Mit komentaren weisst du schon im Vorhinein welche Parts für dich nicht relevant sind.

Auch bei kleineren Projekten die du selber entwickelst sind komentare sehr hilfreich.
So fällt dir der wiedereintsieg nach z.B. einem Jahr unterbruch einiges leichter.

Die Doku schreibe ich getrennt vom Programm. Im Programm selber kommentiere ich nur, wenn irgendwas nicht auf den ersten Blick ersichtlich ist (was es aber eigentlich sein sollte, wenn man Code schreibt) oder es Hintergrund Infos gibt. Wenn später jemand anders dein Projekt übernehmen soll, ist es auch von Vorteil, da zB bei mir in der Abteilung keiner JavaScript kann.
Private Projekte enthalten bei mir normal keine Kommentare. Ich hatte mal eins das später an ~1MB Quellcode gekommen ist und nur welche hatte, wenn irgendwo noch was zu tun war, da konnte man sich von der Ordnerstruktur her auch so gut zurecht finden.

Wir werden in der Uni drauf gedrillt JEDE Funktion und JEDE globale Variable zu kommentieren. Implementierungskommentare sind optional, aber helfen auch. Alles in allem hab ich nie viel vom kommentieren gehalten, aber es hilft enorm wenn man sich mal wo anders einlesen muss :)

Ich arbeite nach dem Grundsatz: Soviel wie nötig, aber so wenig wie möglich. Gut geschriebener Code erklärt sich dann meistens schon von selbst. Bei großen Projekten kann es sicherlich nicht verkehrt sein, die Kommentieren gründlicher zu gestalten.

MfG, Sawyer

Ich denke da muss man abwägen, wenn du Variablennamen benuzt,
die nicht eindeutig sind, würde ich nen Kommentar dazu schreiben wozu die gut sind, ne Variable die im Programm-Kontext Sinn macht braucht man nicht zu kommentieren.
Ebenfalls mit Methoden, beim Methodenaufruf sollte ersichtlich sein was sie so ungefär tut, wenn deine Methoden aber alle meth1-meth10 heißen sind Kommentare sinnfoll.
So kommt es drauf an, wenn dein programm übersichtlich und leicht verständlich ist, brauchst du weniger kommentare, aber wenn es kompliziert wird, sind sie angebracht.

Du kommst auch ohne kommentare ne gewisse zeit lang durchs leben, aber irgendwann brauchst du sie, und da ist es wichtig zu wissen was du kommentiren sollst, oder was in den kommentaren steht, ich hab mir meine erste Prorgrammiersprache (Delphi) selbst beigebracht, und habe ni9chtmal ansatzweise kommentare benuzt, so und dan gugt man sich heute nochmal an was man damals vor vielen jahren verzapft hat und fragt sich, wieso das, wieso hier, was tu ich da,.... (Damals war ich auch kein fan von strukturierung im quelltext^^)

Zitat:

---

Edit: Achja, ich dachte zwar es sei offensichtlich, aber ich trenne Dokumentation und Programmcode.

---

Außer bei VB.NET, da sind die Kommentare gleichzeitig auch der Programmcode.
Wird eventuell an einem Beispiel ersichtlich:

Code:

---

Try
  dblZahl = CDbl(Me.txtZahl.Text)
  dblZähler = 2
  Do Until dblZähler > Math.Sqrt(dblZahl)
      If dblZahl Mod dblZähler = 0 Then
        MessageBox.Show(dblZahl.ToString & _
        " ist keine Primzahl" & vbCr & _
        dblZähler.ToString & "ist ein Teiler")
        Exit Sub
      End If
      dblZähler += 1
  Loop

  MessageBox.Show(dblZahl.ToString & _
  " ist eine Primzahl")
Catch ex As FormatException
  MessageBox.Show("Eingabe falsch!")
Catch ex As DivideByZeroException
  MessageBox.Show("Nicht durch Null teilen")
Catch ex As Exception
  MessageBox.Show(ex.Message)
  MessageBox.Show(ex.StackTrace)
Finally
  dblZähler = 0
  dblZahl = 0
End Try

---

Ich kommentiere meinen Code recht wenig weil sich die Variablen & Funktionsnamen eig. selbst erklären.
Zu größeren Klasse (bei mir haupts. in Javascript) oder Bibliotheken schreib ich meistens ne kleine Dokumentation aber den Code kommentieren finde ich übertrieben.
Ich meine, wenn man eine Sprache beherrscht dann kann man die auch ohne Kommentare lesen.
Man schreibt ja z.B. auch auch keine deutschen Kommentare in einen Artikel für eine englische Internetseite. Auch nicht wenn ihn danach noch ein Freund/Kollege, der eigentlich Englisch können sollte, lesen soll.
Immerhin kann der ja Englisch xD