Abo
  1. Foren
  2. Kommentare
  3. Applikationen
  4. Alle Kommentare zum Artikel
  5. › Computer History Museum…

Codekommentare

  1. Thema

Neues Thema Ansicht wechseln


  1. Codekommentare

    Autor: Beeblox 15.02.13 - 09:27

    > Dass dem Code Kommentare fehlen, sieht Booch eher positiv, denn der Quelltext sei so gut zu lesen, dass Kommentare das vermutlich eher erschwert hätten.

    Eine Erkenntnis, die sich ruhig ein bisschen weiter durchsetzen könnte: Viel besser als das Kommentieren von Code ist es, den Code selbst lesbar zu schreiben. Mit dem Aufkommen von Tools JavaDoc/Doxygen/etc ist es ja leider Usus geworden, Code unleserlich zu schreiben UND schlecht zu dokumentieren.

  2. Re: Codekommentare

    Autor: pythoneer 15.02.13 - 09:37

    Beeblox schrieb:
    --------------------------------------------------------------------------------
    > Mit dem Aufkommen von Tools JavaDoc/Doxygen/etc ist es ja leider
    > Usus geworden, Code unleserlich zu schreiben UND schlecht zu dokumentieren.

    Ernsthaft? JavaDoc/Doxygen/etc hat mir das lesen von Code noch nie erschwert. Ich bin dankbar, wenn ich vor der Funktion/Klasse/etc lesen kann was sie macht. JavaDoc/Doxygen/etc schreibt man doch nicht mitten in den Code wie man es bei normalen Kommentaren macht, sondern als Präambel zu den entsprechenden Elementen. Wer das nicht lesen möchte/braucht überspringt es einfach, im Code hat das Zeugs doch eh nix zu suchen.

  3. Re: Codekommentare

    Autor: Trollster 15.02.13 - 09:46

    Kommentare schreiben muss auch gelernt sein, viele schreiben zu viel und zu unübersichtlich.

    Ist wie guten Code schreiben, beides nicht so einfach für manche.

  4. Re: Codekommentare

    Autor: Beeblox 15.02.13 - 09:47

    pythoneer schrieb:
    --------------------------------------------------------------------------------
    > Beeblox schrieb:
    > ---------------------------------------------------------------------------
    > -----
    > > Mit dem Aufkommen von Tools JavaDoc/Doxygen/etc ist es ja leider
    > > Usus geworden, Code unleserlich zu schreiben UND schlecht zu
    > dokumentieren.
    >
    > Ernsthaft? JavaDoc/Doxygen/etc hat mir das lesen von Code noch nie
    > erschwert.

    Das meinte ich auch nicht. Es führt aber erfahrungsgemäß dazu, dass der Entwickler nicht mehr so stark darauf achtet, dass der Code selbst lesbar ist.

    > Ich bin dankbar, wenn ich vor der Funktion/Klasse/etc lesen kann
    > was sie macht.

    Wenn das nicht aus dem Kontext der Methode ersichtlich ist, ist das schonmal ein Code smell. (Was tut wohl eine Funktion "contains" auf einer Liste?) Allenfalls die Dokumentation von Randfällen / Fehlerverhalten mag sinnvoll sein - sofern sie auch gepflegt wird und nicht nach 2 Revisionen falsch oder zumindest unvollständig ist. Das ist eher der Regelfall.



    1 mal bearbeitet, zuletzt am 15.02.13 09:49 durch Beeblox.

  5. Re: Codekommentare

    Autor: teenriot 15.02.13 - 09:57

    Ein häufiges Problem ist meiner Meinung nach sich 'hineinzufühlen' in einen späteren Zeitpunkt und das zu kommentieren was einem im Moment der Code-Erstellung für selbstverständlich logisch und nicht aufschreibenswert erscheint.
    Man ist im Moment der Code-Erstellung zu nah dran um für jemanden bzw sich selbst zu schreiben für den Umstand das man irgendwann 'weit weg' ist.

  6. Re: Codekommentare

    Autor: dabbes 15.02.13 - 10:47

    Und was macht eine Funktion "contains" mit einer Liste, die aus zig Datenquellen zusammengesetzt ist oder relativ komplexe Datenquelle hat?
    Richtig, das gleiche, aber ohne ordentliche Doku muss ich mir die komplette Funktion anschauen, um zu erkennen, welche Datenquellen wie verwendet werden.

    Guter Code (gute Bezeichner usw.) ist sehr wichtig, ersetzt dennoch keine Doku.

  7. Re: Codekommentare

    Autor: BLi8819 15.02.13 - 11:24

    Grundsätzlich denke ich auch: Wenn Kommentare zwingend notwendig sind, um den Code zu verstehen, ist was schief gelaufen.

    Dennoch finde ich es Sinnvoll die Funktion des Codes auch textuell zu beschreiben. Gerade im Team will ich nicht immer jede Funktion lesen, um zu verstehen, was genau in Ihr passiert.

    Damals in meiner Ausbildung wurde mir immer eingeredet, so viele Kommentare zu machen, wie nur geht. Irgendwann hat man den Code vor lauter Kommentaren gar nicht mehr gesehen.

    Gar keine Kommentare sind aber auch nicht gut. Gerade wenn neue Leute ins Team kommen, sind Kommentare Gold Wert.

    Und manchmal ist es auch gut, einfach selbst nochmal darüber nachzudenken, was man da gerade programmiert hat :-D

  8. Re: Codekommentare

    Autor: Vash 15.02.13 - 13:12

    BLi8819 schrieb:
    --------------------------------------------------------------------------------
    > [...]
    > Gar keine Kommentare sind aber auch nicht gut. Gerade wenn neue Leute ins
    > Team kommen, sind Kommentare Gold Wert.
    >
    > Und manchmal ist es auch gut, einfach selbst nochmal darüber nachzudenken,
    > was man da gerade programmiert hat :-D

    Für mich sind das die beiden wichtigsten Punkte.

    Neben dem wäre noch erwähnenswert das gewisse IDEs in der Lage sind die Funktionskommentare bei der Nutzung der Funktion einzublenden - was oftmals das hinnavigieren, lesen und verstehen der Funktion erleichtert.

    Insbesondere dann wenn diese Funktionen nicht trivial sind, die Implementierung in weiteren Bibliotheken versteckt die vielleicht weder einsehbar noch dokumentiert sind, usw.

  9. IT News für Profis

    Autor: KleinerWolf 16.02.13 - 10:44

    und hier kommen die Hobby Entwickler aus ihren Höhlen gekrochen.

    wir haben mehrere Projekte, ca 3,5-4 Millionen Zeilen Code. Teilstücke sind 25 Jahre alt (C) und über die Jahre hatte mind. 10 Entwickler ihre Finger im Code, welche teilweise nicht mehr in der Firma arbeiten.

    Und dann kommen hier Leute, die evtl ein Programm mit 1000 ( oder lass mal 10k ) Zeilen Code geschrieben haben und erzählen das Kommentare überflüssig sind.

  10. Re: Codekommentare

    Autor: KleinerWolf 16.02.13 - 10:49

    Ich frag mich was ihr teilweise programmiert, das ihr das so verallgemeinert. Es gibt Schnittstellen mit technischen Geräten, die sind so komplex, dass man zwangsläufig Kommentare ( schon für sich selber ) in den Code schreibt.
    Da reicht oft nicht nur eine Dokumentation, sondern man will sich selbst, oder anderen an gewissen Stellen im Code einem direkt klar machen was es macht, oder was man evtl beachten muss.

    Hier denken einige von der Wand bis zur Tapete in ihrer kleinen Hobbyentwicklung.

  11. Re: IT News für Profis

    Autor: das sushi 16.02.13 - 12:06

    programmieren ist aber mehr als kommentare zu schreiben, wie hier schon geschrieben wurde sind kommentare veraltet wenn sie geschrieben wurden, ja manche sachen müssen dokumentiert werden, aber komplexe dokumentationen gehören nicht in den code, ausserdem wenn ein interface so komplex ist das es ne 5 seitige dokumentation braucht, sollte man sich fragen was an dem interface falsch ist, es ist besser kleine schlanke komponenten zu bauen die sich gut warten lassen als code-monster zu schaffen die nach einem halben jahr keiner mehr versteht, programmieren ist ebend mehr als den code einfach nur runter zu tippen, mann muss sich auch gedanken über die struktur, wartbeikeit und zukunfttauglichkeit machen

  12. Re: Codekommentare

    Autor: Eve666 16.02.13 - 12:11

    Ich arbeite momentan an einem Projekt mit inzwischen 4,3 Mio LOC (35 Entwickler) und wir haben keine Kommentare, weil sie nicht benötigt werden. Wenn man streng nach den Regeln des TDD entwickelt und das SRP zur obersten Regel erklärt, dann sind Funktionen niemals schwierig zu verstehen. Die 4-8 Zeilen pro Funktion kann wirklich jeder überblicken. Mit anderen Worten CleanCode funktioniert.

  13. Re: Codekommentare

    Autor: sknoche 16.02.13 - 15:10

    Dem kann ich nur beipflichten.

    In dem Moment, wo zum Verständnis von Code ein Kommentar nötig ist, sollte man sich mal Gedanken machen, ob man diese Stelle nicht besser refactored...

    Kommentare sollten eigentlich nur in Ausnahmefällen zum Zuge kommen, z.B. um die Gründe eines "eigenwilligen" Implementierungsansätze zu erläutern, oder eine Erklärung für nicht offensichtlich notwendige Fehlerbehandlungen zu liefern.

  14. Re: IT News für Profis

    Autor: GodsBoss 16.02.13 - 16:19

    Beitrag von Eve666

    Dass alle Kommentare immer überflüssig sind – halte ich für falsch. Dass in vielen Projekten der überwiegende Teil der Kommentare weggelassen werden könnte, wenn man den Code umbauen würde, halte ich hingegen für richtig.

    Reden ist Silber, Schweigen ist Gold, meine Ausführungen sind Platin.

  15. Re: IT News für Profis

    Autor: ghj 16.02.13 - 16:48

    KleinerWolf schrieb:
    --------------------------------------------------------------------------------
    > und hier kommen die Hobby Entwickler aus ihren Höhlen gekrochen.
    >
    Und da kommen sie, die wir haben das schon immer so gemacht, seit 20...30 Jahren lernresistenten :)



    1 mal bearbeitet, zuletzt am 16.02.13 16:49 durch ghj.

  16. Re: Codekommentare

    Autor: kiviuq 17.02.13 - 11:26

    Ist das Problem / Use Cases allgemein bekannt, die entsprechenden Methoden in der Literatur besprochen sind, braucht man echt keine Kommentare. Zum Beispiel mathematische Probleme oder so etwas wie GoF.

    Nur der gemeine Anwendungsentwickler hat 99% der Fälle mit irgendwelchen abstrusen fachlichen, gesetzlichen oder politischen Anforderungen zu tun, altem Code, unmöglichen Datenmodellen usw., dass man ohne Kommentare eigentliche nicht mehr nachvollziehen kann, warum etwas nun so und nicht anders gemacht werden kann. Da geht's eher um das Warum als das Wie.

    Bei einem Kommentar, weiß man leider nie, ob er überhaupt noch etwas mit der betreffenden Codestelle zu tun hat. Ich mach's halt immer so, dass ich mir die Kommies mit einem Abstand von ein paar Tage noch einmal durchlese und korrigiere.

    Viel wichtiger aber als Kommentare ,sind aber immer noch gute Unit-Tests und(!!) kurze Methoden ohne Seiteneffekte.

  17. Re: Codekommentare

    Autor: GodsBoss 17.02.13 - 18:41

    > Viel wichtiger aber als Kommentare ,sind aber immer noch gute Unit-Tests
    > und(!!) kurze Methoden ohne Seiteneffekte.

    Dito. So wirklich gute Tests lassen sich glatt als Dokumentation verwenden. Die ist dann wenigstens immer aktuell.

    Reden ist Silber, Schweigen ist Gold, meine Ausführungen sind Platin.

Neues Thema Ansicht wechseln


Um zu kommentieren, loggen Sie sich bitte ein oder registrieren Sie sich. Zum Login

Stellenmarkt
  1. SP eCommerce GmbH, Neuss
  2. über Hays AG, München
  3. FANUC Deutschland GmbH, Neuhausen auf den Fildern
  4. Robert Bosch GmbH, Stuttgart-Feuerbach

Golem pur
  • Golem.de ohne Werbung nutzen

Anzeige
Spiele-Angebote
  1. (-15%) 16,99€
  2. + Prämie (u. a. Far Cry 5, Elex, Assassins Creed Origins) für 62€


Haben wir etwas übersehen?

E-Mail an news@golem.de


Matthias Maurer: Ein Astronaut taucht unter
Matthias Maurer
Ein Astronaut taucht unter
  1. Planetologie Forscher finden große Eisvorkommen auf dem Mars
  2. SpaceX Geheimer Satellit der US-Regierung ist startklar
  3. Raumfahrt 2017 Wie SpaceX die Branche in Aufruhr versetzt

Nachbarschaftsnetzwerke: Nebenan statt mittendrin
Nachbarschaftsnetzwerke
Nebenan statt mittendrin
  1. Facebook Messenger Bug lässt iPhone-Nutzer nur wenige Wörter tippen
  2. Nextdoor Das soziale Netzwerk für den Blockwart
  3. Hasskommentare Neuer Eco-Chef Süme will nicht mit AfD reden

Sgnl im Hands on: Sieht blöd aus, funktioniert aber
Sgnl im Hands on
Sieht blöd aus, funktioniert aber
  1. NGSFF alias M.3 Adata zeigt seine erste SSD mit breiterer Platine
  2. Displaytechnik Samsung soll faltbares Smartphone auf CES gezeigt haben
  3. Vuzix Blade im Hands on Neue Datenbrille mit einem scharfen und hellen Bild

  1. Breko: Waipu TV gibt es jetzt für alle Netzbetreiber
    Breko
    Waipu TV gibt es jetzt für alle Netzbetreiber

    Netzbetreiber können jetzt einfach Waipu TV anbieten. Sie müssen mit dem Betreiber Exaring ein Peering und eine Schnittstelle für das Management der Kundendaten einrichten.

  2. Magento: Kreditkartendaten von bis zu 40.000 Oneplus-Käufern kopiert
    Magento
    Kreditkartendaten von bis zu 40.000 Oneplus-Käufern kopiert

    Oneplus hat seine Untersuchung zu kopierten Kreditkarten abgeschlossen. Angreifer konnten wohl eine Schwachstelle für Cross-Site-Scripting ausnutzen.

  3. Games: US-Spielemarkt wächst 2017 zweistellig
    Games
    US-Spielemarkt wächst 2017 zweistellig

    "Spektakulär" findet der wichtigste US-Branchenverband das Wachstum von Gaming-Hardware und -Software im Jahr 2017. Mittlerweile beschäftigen die Unternehmen der Spieleindustrie mehr als 220.000 Mitarbeiter allein in den USA.


  1. 18:53

  2. 17:28

  3. 16:59

  4. 16:21

  5. 16:02

  6. 15:29

  7. 14:47

  8. 13:05