Muster feuvo kommentar

Wenn ein Algorithmus in einem Abschnitt des Programms auf einer Beschreibung in einem Buch oder einer anderen Referenz basiert, können Kommentare verwendet werden, um die Seitenzahl und den Titel des Buches oder Die Anforderung für Kommentare oder eine andere Referenz zu geben. Standardkommentare in SQL sind nur einzeilig, Verwenden von zwei Strichen: Mehrzeilige Kommentare beginnen mit einem Vorwärts-Schrägstrich gefolgt von einem Sternchen (/*) und enden mit einem Sternchen gefolgt von einem Vorwärts-Schrägstrich (*/): Das Ausrufezeichen (!) kann verwendet werden, um Kommentare im Konfigurationsmodus eines Cisco Routers zu markieren, aber solche Kommentare werden nicht im nicht flüchtigen Speicher gespeichert (der die Startkonfiguration enthält), noch werden sie durch den Befehl “show run” angezeigt. [41] [42] MySQL unterstützt auch Kommentare vom Hashzeichen bis zum Ende der Zeile. Mehrzeilige Kommentare: (Kommentare gehen zwischen Schlüsselwörtern “begin” und “end”) Während ich darüber nachdachte, guideless für richtige Code-Kommentare, Ich bin sicher, dass es endlose solche Referenzen online, die mit einer einfachen Suche gefunden werden können. Einige gehen sogar so weit zu geben, niemals Kommentare in Ihrem Code zu geben. In einem anderen Fall glaube ich, dass ich das Problem auf eine bestimmte Klasse beschränkt habe. Beim Öffnen der Klasse sah ich einen riesigen Codeabschnitt, der blockkommentiert wurde. Der verrückte Teil war, der kommentierte Code war in der Mitte der Methode. Also konnte ich den oberen Teil des Codes lesen, dann musste ich ein paar Bildschirme nach unten scrollen, um dort aufzuzeigen, wo der eigentliche Code aufgehört hat. Denken Sie daran, dies ist nicht allzu lange her, so gab es ein Quell-Repository mit der Anwendung verknüpft. Bei der Arbeit an einer webbasierten Anwendung wurde der folgende JavaScript-Kommentar entdeckt: Raku (früher Perl 6 genannt) verwendet die gleichen Zeilenkommentare und POD-Dokumentationskommentare als reguläre Perl (siehe Perl-Abschnitt oben), fügt jedoch einen konfigurierbaren Blockkommentartyp hinzu: “mehrzeilige / eingebettete Kommentare”.

[48] Zeilenkommentare in Perl und vielen anderen Skriptsprachen beginnen mit einem Hashsymbol. Ein Programmierer kann z. B. einen Kommentar hinzufügen, um zu erklären, warum eine Einfügesortanstelle anstelle eines Quicksorts ausgewählt wurde, da ersteres theoretisch langsamer ist als der letztere. Dies könnte wie folgt geschrieben werden: In diesem klassischen frühen BASIC-Codefragment wird das Schlüsselwort REM (“Remark”) verwendet, um Kommentare hinzuzufügen. Zeilenkommentare in Haskell beginnen mit `–` (zwei Bindestriche) bis zum Ende der Zeile, und mehrere Zeilenkommentare beginnen mit `-`und enden mit `-“. Es ist auch möglich, einen regulären Ausdruck abzurufen, der Kommentaren entspricht (bis zur nächsten Codezeile): Diese Detailgenauigkeit wäre jedoch im Kontext von Produktionscode oder anderen Situationen, in denen erfahrene Entwickler beteiligt sind, nicht angemessen. Solche rudimentären Beschreibungen stimmen mit der Richtlinie nicht überein: “Gute Kommentare … Absicht zu klären.” [10] Darüber hinaus ist für professionelle Codierungsumgebungen der Detaillierungsgrad in der Regel genau definiert, um eine spezifische Leistungsanforderung zu erfüllen, die durch Den Geschäftsbetrieb definiert wird. [31] Manchmal enthält der Quellcode eine neuartige oder bemerkenswerte Lösung für ein bestimmtes Problem. In solchen Fällen können Kommentare eine Erläuterung der Methodik enthalten.

Solche Erklärungen können Diagramme und formale mathematische Beweise enthalten. Dies kann eine Erklärung des Kodex darstellen, anstatt seine Absicht zu präzieren; aber andere, die mit der Aufrechterhaltung der Codebasis beauftragt sind, können eine solche Erklärung als entscheidend empfinden.