Als «comments» getaggte Fragen

Fragen zum Schreiben von Kommentaren in Code.

86
Machen TODO-Kommentare Sinn? [geschlossen]

Ich arbeite an einem ziemlich großen Projekt und habe die Aufgabe, einige Übersetzungen dafür zu machen. Es gab Unmengen von Etiketten, die nicht übersetzt wurden, und während ich den Code durchsuchte, fand ich dieses kleine Stück Code //TODO translations Dies brachte mich dazu, über den Sinn...

83
Clean Code-Kommentare vs. Klassendokumentation

Ich habe einige Diskussionen mit meinen neuen Kollegen über das Kommentieren. Wir beide mögen Clean Code , und ich bin völlig in Ordnung mit der Tatsache, dass Inline-Code-Kommentare vermieden werden sollten und dass Klassen- und Methodennamen verwendet werden sollten, um auszudrücken, was sie...

72
Was bedeutet XXX in einem Kommentar? [geschlossen]

Was bedeuten Menschen im Allgemeinen, wenn Sie XXXin einem Kommentar sehen. Gelegentlich sehe ich einen Kommentar wie diesen: # XXX - This widget really should frobulate the whatsit Natürlich kann ich sagen, was der Kommentar bedeutet, aber was bedeutet der XXX im Allgemeinen? Sagt es "Dies ist...

49
Warum sind /// Kommentarblöcke wichtig?

Jemand hat einmal gesagt, wir sollten allen unseren Methoden die /// <summary>Kommentarblöcke (C #) voranstellen , haben aber nicht erklärt, warum. Ich habe angefangen, sie zu verwenden, und festgestellt, dass sie mich ziemlich geärgert haben. Daher habe ich sie mit Ausnahme von Bibliotheken...

38
Sind veraltete Kommentare ein urbaner Mythos?

Ich sehe ständig Leute, die behaupten, dass "Kommentare dazu neigen, veraltet zu sein". Die Sache ist, ich denke, ich habe vielleicht zwei oder drei veraltete Kommentare in meiner gesamten Karriere gesehen. Veraltete Informationen in separaten Dokumenten kommen immer wieder vor, aber meiner...

34
Kommentar vor oder nach dem entsprechenden Code [geschlossen]

Angenommen, ein Kommentar passt nicht in die Zeile, für die er gilt (oder kann nicht), sollte man den Kommentar vor oder nach dem Code schreiben? Nun, wo auch immer zukünftige Leser den Umfang des Kommentars am besten verstehen werden. Mit anderen Worten, überall dort, wo die meisten Programmierer...