Du bist nicht angemeldet.

Stilllegung des Forums
Das Forum wurde am 05.06.2023 nach über 20 Jahren stillgelegt (weitere Informationen und ein kleiner Rückblick).
Registrierungen, Anmeldungen und Postings sind nicht mehr möglich. Öffentliche Inhalte sind weiterhin zugänglich.
Das Team von spieleprogrammierer.de bedankt sich bei der Community für die vielen schönen Jahre.
Wenn du eine deutschsprachige Spieleentwickler-Community suchst, schau doch mal im Discord und auf ZFX vorbei!

Werbeanzeige

NachoMan

Community-Fossil

Beiträge: 3 885

Wohnort: Berlin

Beruf: (Nachhilfe)Lehrer (Mathematik, C++, Java, C#)

  • Private Nachricht senden

11

16.09.2014, 19:46

Code kommentieren

Immer wenn man auf die Idee kommt einen Kommentar zu schreiben, sollte man überlegen ob eine neue Funktion/Methode mit entsprechenden Namen nicht sinnvoller wäre(das ist nämlich meistens der Fall).

Beispiel:

C-/C++-Quelltext

1
2
3
4
5
...
float x = 10;
float y = 12;
float length = sqrt(x*x + y*y); //Berechnet die Länge des Vectors
...

Besser ist:

C-/C++-Quelltext

1
2
3
4
5
6
7
8
9
...
float x = 10;
float y = 12;
float length = calcLength(x, y);
...
float calcLength(float x, float y)
{
    return sqrt(x*x + y*y);
}

In meinem Code findet man in der Regel garkeine Kommentare(abgesehen von der Doxygen Doku). Schon Fortgeschrittene können sauberen Code schneller lesen als jeden Kommentar. Ein Kommentar muss ausformuliert werden. Dabei werden viel mehr Wörter benutzt als man für den Inhalt eigentlich bräuchte. Die Grammatik der C-Programmiersprachen-Familie ist hingegen auf das nötigste Reduziert.

Noch besser wäre natürlich eine Klasse Vector2 mit entsprechender Methode.
"Der erste Trunk aus dem Becher der Erkenntnis macht einem zum Atheist, doch auf dem Grund des Bechers wartet Gott." - Werner Heisenberg
Biete Privatunterricht in Berlin und Online.
Kommt jemand mit Nach oMan?

Dieser Beitrag wurde bereits 5 mal editiert, zuletzt von »NachoMan« (16.09.2014, 19:59)


Fireball

Alter Hase

Beiträge: 415

Wohnort: Werne

Beruf: Dipl. Inf.

  • Private Nachricht senden

12

17.09.2014, 09:20

Ein Kommentar tut aber nicht weh, wenn man einen ausgeklügelten Code Teil implementiert.

David Scherfgen

Administrator

Beiträge: 10 382

Wohnort: Hildesheim

Beruf: Wissenschaftlicher Mitarbeiter

  • Private Nachricht senden

13

17.09.2014, 09:31

Kommentare finde ich schon sinnvoll, wenn sie die Idee erläutern, wie etwas funktioniert. Auch sowas wie "Das Folgende funktioniert, weil ...","Hier müssen wir nicht prüfen, ob ..." oder "Vorsicht, auf diese Variable wird aus mehreren Threads heraus zugegriffen!" finde ich angebracht.
Wenn ein Kommentar nur das wiederholt, was sich aus dem Code sofort ergibt (weil es sehr einfach ist oder weil die Namen der Objekte/Funktionen/Methoden für sich sprechen), dann ist er unnötig.

14

17.09.2014, 12:05

Danke für eure Antworte.
Die Kommentare hab ich Ausgelassen weil bei so einen Quellcode Kommentare
unnötig sein.

Fireball

Alter Hase

Beiträge: 415

Wohnort: Werne

Beruf: Dipl. Inf.

  • Private Nachricht senden

15

17.09.2014, 12:17

Den besten Kommentar den ich jeh gelesen habe war in einem Java Programm, da kam ein Objekt zurück.

// Den Typ dieses Objekts kennt nur Gott.


Leider war ich zu dem Zeitpunkt noch nicht im Unternehmen, als das gefrickelt wurde ... auf sowas komme ich nämlich gar nicht klar. :pillepalle:

Werbeanzeige