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!

Frage zum Kommentieren

Werbeanzeige

rnlf

Frischling

Beiträge: 85

Beruf: Softwareingenieur Raumfahrt

  • Private Nachricht senden

81

28.06.2012, 17:58

Der Gedanke ist auch gewesen, dass man am Anfang versucht, saubere API-Dokumentation zu schreiben, wenn man Zeit hat und sich auch noch wirklich um sauberen Code bemüht. Ich hatte aber noch nie das Glück, in einem Projekt zu arbeiten, in dem durch welche Gründe auch immer, am Ende die Zeit nicht knapp wurde. Deshalb spare ich von vornherein API-Dokumentation, weil sie spätestens dann nix mehr wert ist.
Mein Blog

DoctorEarlyn

Frischling

  • »DoctorEarlyn« ist der Autor dieses Themas

Beiträge: 15

Beruf: Schüler

  • Private Nachricht senden

82

28.06.2012, 22:05

@BlueCobold

Kann man so sagen. Aber durchaus interessant. :D Habe gegen den Schluss aber nicht mehr alle Beiträge gelesen, da die meisten Beiträge inhaltlich wiederhohlt auf mich wirkten.
Achtung: Kreative Signatur

Nox

Supermoderator

Beiträge: 5 272

Beruf: Student

  • Private Nachricht senden

83

29.06.2012, 01:14

Ich würde Kommentare nicht per se verteufeln, denn ich denke es gibt sie nicht ohne Grund und ich denke auch in "guten" Code (was genau versteht man denn unter gut?) dürfen erläuternde Kommentare vorhanden sein, denn im Alltag können gut platzierte Kommentare echt auf die Sprünge helfen, außer man will den Nutzer eine komplette Lektüre des Codes gönnen. In wiefern Kommentare notwendig sind oder nicht steht nochmal auf einem anderen Blatt (gibt ja angeblich auch Leute die Brainfuck Programme direkt lesen und verstehen können; die brauchen auch keine Kommentare).
Oder salopp gesagt: Gut platzierte Kommentare können nicht schaden (es geht doch nichts über moralisch überlegene Aussagen, da "gut" ja irgendwie automatisch "richtig/korrekt" impliziert und Gegenbeispiele automatisch irgendwie für "falsche" Anwendung/Bezug stehen :rolleyes: ).
PRO Lernkurs "Wie benutze ich eine Doku richtig"!
CONTRA lasst mal die anderen machen!
networklibbenc - Netzwerklibs im Vergleich | syncsys - Netzwerk lib (MMO-ready) | Schleichfahrt Remake | Firegalaxy | Sammelsurium rund um FPGA&Co.

BlueCobold

Community-Fossil

Beiträge: 10 738

Beruf: Teamleiter Mobile Applikationen & Senior Software Engineer

  • Private Nachricht senden

84

29.06.2012, 07:07

Dem kann ich mehr oder minder zustimmen, Nox.
(das wird "Spiele Programmierer" jetzt sicher verwirren, wo er den Unterschied zwischen brauchen und dürfen ja nicht kennt ;)
Teamleiter von Rickety Racquet (ehemals das "Foren-Projekt") und von Marble Theory

Willkommen auf SPPRO, auch dir wird man zu Unity oder zur Unreal-Engine raten, ganz bestimmt.[/Sarkasmus]

David Scherfgen

Administrator

Beiträge: 10 382

Wohnort: Hildesheim

Beruf: Wissenschaftlicher Mitarbeiter

  • Private Nachricht senden

85

29.06.2012, 07:51

Ich benutze Kommentare auch oft für mich selbst, um meine Gedankengänge für einen Algorithmus niederzuschreiben.
David Scherfgens Website | Konzentrationstest Polizei

BlueCobold

Community-Fossil

Beiträge: 10 738

Beruf: Teamleiter Mobile Applikationen & Senior Software Engineer

  • Private Nachricht senden

86

29.06.2012, 08:15

Das kenn ich auch, ja. Man tippt erstmal nieder, wie das denn abzulaufen hat, dann programmiert man's runter. Ist aber doch eher selten und mehr beim Lösen irgendwelcher Gleichungssysteme als bei der täglichen Arbeit.
Teamleiter von Rickety Racquet (ehemals das "Foren-Projekt") und von Marble Theory

Willkommen auf SPPRO, auch dir wird man zu Unity oder zur Unreal-Engine raten, ganz bestimmt.[/Sarkasmus]

babelfish

Alter Hase

Beiträge: 1 222

Wohnort: Schweiz

Beruf: Informatiker

  • Private Nachricht senden

87

29.06.2012, 11:31

Ich benutze Kommentare oft zur Strukturierung von Code. z.B. für jede Funktion ein Kommentar-Head.
Das gibt mir eine gute Übersicht beim scrollen durch den Quelltext.

Aber wozu bräuchte folgender Code z.B. noch Erläuterungen?

C#-Quelltext

 
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

// ==================================================
// || OnEnemyFire
protected function OnEnemyFire(enemy:SpaceIndividual) : void
{
    if (enemy is BlueMinion || enemy is RedMinion)
    {
        var bullets:Array = enemy.Fire();
        
        for each(var bullet:Bullet in bullets)
        {                   
            this.EnemyBullets.add(bullet);      
        }
    }
    else if (enemy is PurpleMinion)
    {
        var bullets:Array = enemy.Fire();
        
        for each(var bullet:Bullet in bullets)
        {
            FlxVelocity.moveTowardsObject(bullet, this.Player, enemy.GetBulletSpeed()); 
            this.EnemyBullets.add(bullet);      
        }
    }
}
Man kann sich jetzt natürlich überlegen wie weit das mit "is" ein Fehldesign ist. Mir gefällts so ;)

BlueCobold

Community-Fossil

Beiträge: 10 738

Beruf: Teamleiter Mobile Applikationen & Senior Software Engineer

  • Private Nachricht senden

88

29.06.2012, 12:33

Für solche Strukturierung finde ich Kommentare gerade bei C++ z.B. sehr sehr vorteilhaft, weil da bei mehr als 5 Funktionen oder Methoden doch schnell mal die Übersicht verloren geht. Ich weiß nicht genau warum, aber ich finde mich da schlechter zurecht als vergleichsweise bei C# oder Java. Und das war sogar noch in meinen C++ Zeiten schon so ;)
Teamleiter von Rickety Racquet (ehemals das "Foren-Projekt") und von Marble Theory

Willkommen auf SPPRO, auch dir wird man zu Unity oder zur Unreal-Engine raten, ganz bestimmt.[/Sarkasmus]

David Scherfgen

Administrator

Beiträge: 10 382

Wohnort: Hildesheim

Beruf: Wissenschaftlicher Mitarbeiter

  • Private Nachricht senden

89

29.06.2012, 13:12

In C# gibts #regions, die finde ich auch super, um große Quellcodedateien übersichtlich zu halten.
David Scherfgens Website | Konzentrationstest Polizei

BlueCobold

Community-Fossil

Beiträge: 10 738

Beruf: Teamleiter Mobile Applikationen & Senior Software Engineer

  • Private Nachricht senden

90

29.06.2012, 14:08

Oh ja. Vor allem weil sie schachtelbar sind. Das macht schon viel aus.
Teamleiter von Rickety Racquet (ehemals das "Foren-Projekt") und von Marble Theory

Willkommen auf SPPRO, auch dir wird man zu Unity oder zur Unreal-Engine raten, ganz bestimmt.[/Sarkasmus]

Werbeanzeige

Ähnliche Themen