Als «comments» getaggte Fragen

Fragen zum Schreiben von Kommentaren in Code.

12
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 Erfahrung nach sind veraltete Kommentare im Code selbst …
38 comments  myth 
13
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 / Skripter …
34 comments 
5
Wie werden Kommentare normalerweise analysiert?
Wie werden Kommentare generell in Programmiersprachen und Markups behandelt? Ich schreibe einen Parser für eine benutzerdefinierte Auszeichnungssprache und möchte dem Prinzip der geringsten Überraschung folgen , also versuche ich, die allgemeine Konvention zu bestimmen. Soll beispielsweise ein in ein Token eingebetteter Kommentar das Token stören oder nicht? Im Allgemeinen ist …
31 parsing  comments 
6
Anfängerleitfaden zum Schreiben von Kommentaren?
Gibt es eine definitive Anleitung zum Schreiben von Code-Kommentaren für angehende Entwickler? Im Idealfall geht es darum, wann Kommentare verwendet werden sollten (und welche nicht) und welche Kommentare enthalten sollten. Diese Antwort : Kommentieren Sie nicht, WAS Sie tun, sondern WARUM Sie es tun. Das WAS wird durch sauberen, lesbaren …
9
Stil und Empfehlungen zum Kommentieren von Code
Ich möchte von Ihnen alle Ratschläge und Erfahrungen zum Schreiben von Kommentaren in Ihren Code hören. Wie schreibt man sie am einfachsten und informativsten? Welche Angewohnheiten haben Sie beim Kommentieren von Codeteilen? Vielleicht ein paar exotische Empfehlungen? Ich hoffe, dass diese Frage die interessantesten Ratschläge und Empfehlungen für Kommentare enthält, …
6
So lösen Sie das Problem verschachtelter Kommentare
Es erscheint nicht nur in einer Sprache, dass Kommentare nicht verschachtelt werden können. Haben Sie eine gute Lösung für dieses Problem? Eine Problemumgehung in C / C ++ und Java besteht darin, nur den einzeiligen Kommentar zu verwenden. In diesem Fall ist es jedoch unmöglich, einen größeren Block auszukommentieren. Ich …
23 java  c++  python  c  comments 
21
Selbstdokumentierender Code Vs. Kommentierter Code
Verschlossen . Diese Frage ist gesperrt, da es viele Kommentare außerhalb des Themas gab. Derzeit werden keine neuen Antworten oder Interaktionen akzeptiert. Ich habe gesucht, aber nicht gefunden, wonach ich gesucht habe. Bitte verlinken Sie mich, wenn diese Frage bereits gestellt wurde. Anfang dieses Monats wurde dieser Beitrag verfasst: http://net.tutsplus.com/tutorials/php/why-youre-a-bad-php-programmer/ …
6
Warum ist es falsch, Code zu kommentieren und ihn dann nach und nach zu entfernen, um zu verfolgen, was ich bereits getan habe und was noch zu tun ist?
Immer wenn ich feststelle, dass ein großer Teil meines Codes geändert werden muss, entweder weil er falsch ist oder weil er an wichtige architektonische Änderungen angepasst werden muss, die aus anderen Gründen erforderlich sind, ist dies das, was ich normalerweise tue: Ich kommentiere den gesamten Code aus, von dem ich …
Durch die Nutzung unserer Website bestätigen Sie, dass Sie unsere Cookie-Richtlinie und Datenschutzrichtlinie gelesen und verstanden haben.
Licensed under cc by-sa 3.0 with attribution required.