Kommentar (Computerprogrammierung)

Eine Illustration von Java Quellcode mit Prolog Kommentare angegeben in rot und in der Reihe Kommentare in grün. Programmcode ist in blau.

Im Computerprogrammierung, a Kommentar ist eine Programmiererlesenserklärung oder Anmerkung in dem Quellcode von a Computer Programm. Sie werden hinzugefügt, um den Quellcode für Menschen zu verstehen, und werden im Allgemeinen von ignoriert von Compiler und Dolmetscher.^[1][2] Das Syntax von Kommentaren In verschiedenen Programmiersprachen variieren erheblich.

Kommentare werden manchmal auch auf verschiedene Weise verarbeitet, um Dokumentation extern zum Quellcode selbst zu generieren Dokumentationsgeneratoren, oder zur Integration mit Quellcodeverwaltung Systeme und andere Arten von externen Programmierwerkzeuge.

Die Flexibilität, die durch Kommentare bereitgestellt werden, ermöglicht ein breites Maß an Variabilität, aber formale Konventionen für ihre Verwendung sind häufig Teil der Programmierleitfäden im Programmierstil.

Überblick

Kommentare sind im Allgemeinen als beide formatiert Block Kommentare (auch genannt Prolog Kommentare oder Stream -Kommentare) oder Zeilenkommentare (auch genannt Inline -Kommentare).^[3]

Block Kommentare abgrenzen Ein Region des Quellcodes, der mehrere Zeilen oder einen Teil einer einzelnen Zeile umfassen kann. Diese Region ist mit a spezifiziert Anfang Abgrenzer und an Ende Abgrenzer. Einige Programmiersprachen (wie z. Matlab) Erlauben Sie, dass Blockkommentare rekursiv ineinander verschachtelt werden, aber andere (wie z. Java) unterlassen Sie.^[4][5][6]

Zeilenkommentare beginnen entweder mit einem Kommentar -Trennzeichen und fahren bis zum Ende der Zeile fort oder in einigen Fällen in einer bestimmten Spalte (Zeichenlinienversetzt) ​​im Quellcode und fahren Sie bis zum Ende der Zeile fort.^[6]

Einige Programmiersprachen verwenden sowohl Block- Zum Beispiel, C ++ Hat Blockkommentare von Grenz gemacht von /* und */ Das kann mehrere Zeilen und Zeilenkommentare umfassen //. Andere Sprachen unterstützen nur eine Art von Kommentar. Zum Beispiel, Ada und Lua Kommentare sind Zeilenkommentare: Sie beginnen mit -- und bis zum Ende der Linie weiter.^[6]

Verwendet

Wie Sie am besten Kommentare verwenden können, unterliegt Streit; Verschiedene Kommentatoren haben unterschiedliche und manchmal entgegengesetzte Standpunkte angeboten.^[7][8] Es gibt viele verschiedene Möglichkeiten zum Schreiben von Kommentaren und viele Kommentatoren geben widersprüchliche Ratschläge.^[8]

Planung und Überprüfung

Kommentare können als Form von verwendet werden Pseudocode Um die Absicht vor dem Schreiben des tatsächlichen Codes zu skizzieren. In diesem Fall sollte es die Logik hinter dem Code und nicht den Code selbst erläutern.

/* Schleifen Sie rückwärts über alle vom Server zurückgegebenen Elemente zurück  (Sie sollten chronologisch verarbeitet werden)*/ zum (i = (Zahlen - 1); i > = 0; i--) {   / * Verarbeiten Sie die Daten jedes Elements */   UpdatePattern(i, Rückkehredelemente[i]); } 

Wenn diese Art von Kommentar verbleibt, vereinfacht sie den Überprüfungsprozess, indem ein direkter Vergleich des Codes mit den beabsichtigten Ergebnissen ermöglicht wird. Ein häufiger logischer Irrtum ist der Code, der leicht zu verstehen ist soll machen.

Code Beschreibung

Kommentare können verwendet werden, um Code zusammenzufassen oder die Absicht des Programmierers zu erklären. Nach dieser Denkschule wird das Wiederherstellen des Code in einfachem Englisch als überflüssig angesehen. Die Notwendigkeit, Code erneut zu erläutern, kann ein Zeichen dafür sein, dass er zu komplex ist und umgeschrieben werden sollte oder dass die Benennung schlecht ist.

"Dokumentieren Sie keinen schlechten Code - schreiben Sie ihn neu."^[9]

"Gute Kommentare wiederholen den Code nicht oder erklären Sie ihn nicht. Sie klären seine Absicht. Kommentare sollten auf einer höheren Abstraktionsebene als der Code erklären, was Sie versuchen zu tun."^[10]

Kommentare können auch verwendet werden, um zu erklären, warum ein Codeblock nicht zu Konventionen oder Best Practices passt. Dies gilt insbesondere für Projekte, die nur sehr wenig Entwicklungszeit oder Fehler beheben. Zum Beispiel:

'Second Variable Dim aufgrund von Serverfehlern, die bei Wiederverwendungsformatdaten erstellt wurden. Nein 'Dokumentation im Problem des Serververhaltens verfügbar, also kodieren Sie einfach um sie herum. VTX = Server.Mappath("lokale Einstellungen") 

Algorithmische Beschreibung

Manchmal enthält der Quellcode eine neuartige oder bemerkenswerte Lösung für ein bestimmtes Problem. In solchen Fällen können Kommentare eine Erklärung der Methodik enthalten. Solche Erklärungen können Diagramme und formale mathematische Beweise umfassen. Dies kann eher die Erklärung des Kodex als eine Klärung seiner Absicht darstellen; Aber andere, die mit der Aufrechterhaltung der Codebasis beauftragt sind, können eine solche Erklärung entscheidend finden. Dies kann insbesondere bei hochspezialisierten Problembereichen der Fall sein. oder selten verwendete Optimierungen, Konstrukte oder Funktionsanalte.^[11]

Zum Beispiel kann ein Programmierer einen Kommentar hinzufügen, um zu erklären, warum eine Sortieren durch Einfügen wurde anstelle von a ausgewählt schnelle Sortewie erstere theoretisch langsamer als das letztere. Dies könnte wie folgt geschrieben werden:

 aufführen = [f (b), f (b), f (c), f (d), f (a), ...];  // brauche eine stabile Art. Außerdem spielt die Leistung wirklich keine Rolle.  Sortieren durch Einfügen (aufführen); 

Ressourceneinschluss

Logos, Diagramme und Flussdiagramme bestehend aus ASCII Art Konstruktionen können als Kommentar in den formatierten Quellcode eingefügt werden.^[12] Des Weiteren, Urheberrechte © Mitteilungen können als Kommentare in den Quellcode eingebettet werden. Binärdaten können auch in Kommentaren durch einen bekannten Prozess als kodiert werden Binär-bis-Text-KodierungObwohl eine solche Praxis ungewöhnlich ist und in der Regel in externe Ressourcendateien verwiesen wird.

Das folgende Codefragment ist ein einfaches ASCII -Diagramm, das den Prozessfluss für a zeigt Systemadministration Skript in a enthalten Windows -Skriptdatei untereinander laufen Windows -Skript -Host. Obwohl ein Abschnitt, der den Code markiert, als Kommentar erscheint, erscheint das Diagramm selbst tatsächlich in einem Xml CDATA Abschnitt, der technisch von Kommentaren unterscheidet, aber ähnliche Zwecke dienen kann.^[13]

  id ="ProcessDiagram000">   HostApp (main_process)     |     V script.wsf (app_cmd) -> clientapp (async_run, batch_process)                 |                 |                 V          MRU.ini (MRU_HISTORY)  ]]>  

Obwohl dieses identische Diagramm leicht als Kommentar aufgenommen werden könnte, zeigt das Beispiel eine Instanz, in der sich ein Programmierer möglicherweise entscheiden, Kommentare nicht als Mittel zur Einbeziehung von Ressourcen in den Quellcode zu verwenden.^[13]

Metadaten

Kommentare in einem Computerprogramm speichern häufig Metadaten über eine Programmdatei.

Insbesondere viele Software -Betreuer Geben Sie Einreichungsrichtlinien in Kommentare ein, um Personen zu helfen, die den Quellcode dieses Programms lesen, um Verbesserungen zu senden, die sie an den Betreuer vornehmen.

Andere Metadaten umfassen: der Name des Erstellers der Originalversion der Programmdatei und das Datum, an dem die erste Version erstellt wurde, der Name des aktuellen Betreuers des Programms, die Namen anderer Personen, die die bisherige Programmdatei bearbeitet haben , die URL der Dokumentation zur Verwendung des Programms, der Name des Softwarelizenz für diese Programmdatei usw.

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 Seitennummer und den Titel des Buches zu geben oder Anfrage für Kommentare oder andere Referenz.

Debuggen

Eine häufige Entwicklerpraxis ist zu auskommentieren Ein Code -Snippet, was bedeutet, eine Kommentarsyntax hinzuzufügen, die dazu führt, dass dieser Codeblock zu einem Kommentar wird, so dass er im endgültigen Programm nicht ausgeführt wird. Dies kann getan werden, um bestimmte Code -Teile aus dem endgültigen Programm auszuschließen, oder (häufiger) kann verwendet werden, um die Quelle eines Fehlers zu finden. Durch systematisch Aussagen und Ausführen von Teilen des Programms kann die Quelle eines Fehlers bestimmt werden, sodass es korrigiert werden kann.

Viele IDEs ermöglichen das schnelle Hinzufügen oder Entfernen solcher Kommentare mit einzelnen Menüoptionen oder Schlüsselkombinationen. Der Programmierer muss nur den Teil des Textes markieren, den er (Un-) Kommentar wünscht, und die entsprechende Option auswählen.

Automatische Dokumentationsgenerierung

Programmierwerkzeuge manchmal speichern Dokumentation und Metadaten in Kommentaren.^[14] Diese können Positionen zur automatischen Header -Dateieinschließung einfügen und Befehle zum Festlegen der Datei der Datei festlegen Satzstellung markieren Modus,^[15] oder die Datei der Datei Revisionsnummer.^[16] Diese funktionalen Kontrollkommentare werden auch allgemein als als bezeichnet Anmerkungen. Die Dokumentation innerhalb von Quellcode -Kommentaren wird als eine Möglichkeit zur Vereinfachung des Dokumentationsprozesses angesehen und die Wahrscheinlichkeit erhöht, dass die Dokumentation mit Änderungen im Code auf dem Laufenden gehalten wird.^[17]

Beispiele für Dokumentationsgeneratoren umfassen die Programme Javadoc zum Gebrauch mit Java, DDOC zum D, Doxygen zum C, C ++, Java, Idl, Visueller Experte zum PL/sql, Transact-SQL, Powerbuilder und Phpdoc zum Php. Arten von docstring werden unterstützt von Python, Lispeln, Elixier, und Clojure.^[18]

C#, F# und Visual Basic .net Implementieren Sie eine ähnliche Funktion namens "XML -Kommentare", die von gelesen werden von Intellisense Aus dem zusammengestellten .NETZ Montage.^[19]

Syntaxerweiterung

Gelegentlich werden Syntaxelemente, die ursprünglich als Kommentare gedacht waren, neu gepandelt, um zusätzliche Informationen an ein Programm zu übermitteln, wie z. "Bedingte Kommentare"Solche" heißen Kommentare "können die einzige praktische Lösung sein, die die Rückwärtskompatibilität beibehält, aber weithin als als angesehen wird kludge.^[20]

Richtlinie verwendet

Es gibt Fälle, in denen die normalen Kommentarcharaktere kooptiert werden, um ein Special zu erstellen Richtlinie Für einen Herausgeber oder Dolmetscher.

Zwei Beispiele für diese Regie eines Dolmetschers sind:

• Die Unix "Shebang" - - #! - Wird in der ersten Zeile eines Skripts verwendet, um auf den zu verwendenden Interpreter zu verweisen.
• "Magische Kommentare" identifiziert, dass die Codierung einer Quelldatei verwendet wird, wird verwendet,^[21] z.B. Pythons Pep 263.^[22]

Das folgende Skript für ein Unix-ähnliches System zeigt beide Verwendungen:

#!/usr/bin/env python3 #-*-Codierung: UTF-8-*- drucken("Testen") 

Etwas ähnlich ist die Verwendung von Kommentaren in C, um einem Compiler mitzuteilen, dass ein Standard "Falsch" in a Fallerklärung wurde absichtlich gemacht:

Schalter (Befehl) {   Fall Cmd_show_help_and_exit:   do_show_help();   / * Durchfallen *///   Fall Cmd_exit:   do_exit();   Unterbrechung;   Fall Cmd_other:   do_other();   Unterbrechung;   /* ... etc. ... */   } 

Ein solches einfügen / * Durchfallen */// Kommentar für menschliche Leser war bereits eine gemeinsame Konvention, aber 2017 die GCC Der Compiler suchte nach diesen (oder anderen Anzeichen einer absichtlichen Absicht) und, wenn nicht gefunden, ausgab: "Warnung: Diese Aussage kann durchfallen".^[23]

Viele Redakteure und Ides wird speziell formatierte Kommentare lesen. Zum Beispiel das "modelline" -Feature von Vim; Dies würde seine Handhabung von Registerkarten ändern, während sie mit diesem Kommentar eine Quelle bearbeiten, die oben in der Datei enthalten ist:

# vim: tabStop = 8 expandtab ShiftWidth = 4 SoftTabStop = 4

Entspannung

Manchmal fügt Programmierer Kommentare hinzu, um Stress abzubauen, indem sie Entwicklungstools, Wettbewerber, Arbeitgeber, Arbeitsbedingungen oder die Qualität des Code selbst kommentieren.^[24] Das Auftreten dieses Phänomens ist leicht aus Online -Ressourcen zu erkennen, die verfolgen Profanität im Quellcode.^[25]

Normative Ansichten

Es gibt verschiedene normative Ansichten und langjährige Meinungen zur ordnungsgemäßen Verwendung von Kommentaren im Quellcode.^[26][27] Einige davon sind informell und basieren auf persönlichen Präferenzen, während andere als formale Richtlinien für eine bestimmte Gemeinschaft veröffentlicht oder verkündet werden.^[28]

Bedarf für Kommentare

Experten haben unterschiedliche Ansichtspunkte dafür, ob und wann Kommentare im Quellcode angemessen sind.^[9][29] Einige behaupten, dass der Quellcode mit wenigen Kommentaren geschrieben werden sollte, weil der Quellcode selbsterklärend sein sollte oder Selbstdokumentation.^[9] Andere schlagen vorWhitespace Zeichen im Quellcode, die in Kommentaren enthalten sind).^[30][31]

Zwischen diesen Ansichten befindet sich die Behauptung, dass Kommentare weder für sich selbst nützlich noch schädlich sind, und es ist wichtig, dass sie korrekt sind und mit dem Quellcode synchronisiert sind und weggelassen sind, wenn sie überflüssig, übermäßig, schwer zu erhalten oder auf andere Weise nicht hilfreich sind.^[32][33]

Kommentare werden manchmal verwendet, um Verträge in der zu dokumentieren Entwurf durch Vertrag Ansatz zur Programmierung.

Detaillierungsgrad

Abhängig vom beabsichtigten Publikum des Codes und anderer Überlegungen kann der Detail- und Beschreibung erheblich variieren.

Beispielsweise wäre der folgende Java -Kommentar in einem einleitenden Text geeignet, der für das Programmieren von Beginn der Programme lehrt:

Saite s = "Wikipedia"; /* Weist der Variablen s den Wert "Wikipedia" zu. */ 

Diese Detailgenauigkeit wäre jedoch im Kontext des Produktionscode oder in anderen Situationen, in denen erfahrene Entwickler beteiligt sind, nicht angemessen. Solche rudimentären Beschreibungen stehen im Widerspruch zu der Richtlinie: "Gute Kommentare ... Klärung der Absicht."^[10] Darüber hinaus ist für professionelle Codierungsumgebungen das Detailniveau normalerweise gut definiert, um einen spezifischen Leistungsanforderungen zu erfüllen, der durch Geschäftsbetriebe definiert ist.^[31]

Stile

Es gibt viele stilistische Alternativen, wenn man überlegt, wie Kommentare im Quellcode angezeigt werden sollen. Für größere Projekte, an denen ein Entwicklerteam beteiligt ist, werden Kommentare entweder vereinbart, bevor ein Projekt beginnt, oder sich aus dem Konvention oder dem Bedarf mit zunehmendem Projekt weiterentwickeln. Normalerweise bevorzugen Programmierer Stile, die konsistent, nicht oberstruktiv, leicht zu ändern und schwer zu brechen sind.^[34]

Block Kommentar

Die folgenden Codefragmente in C zeigen nur ein winziges Beispiel dafür, wie Kommentare stilistisch variieren können und gleichzeitig dieselben grundlegenden Informationen vermitteln:

/*      Dies ist der Kommentarkörper.      Variation eins. */ 

/************************* \ * * * Dies ist der Kommentarkörper. * * Variation zwei. * * * \ *************************/ 

Faktoren wie persönliche Präferenz, Flexibilität von Programmierwerkzeugen und andere Überlegungen beeinflussen die im Quellcode verwendeten stilistischen Varianten. Zum Beispiel könnte die Variation zwei bei Programmierern, die es nicht haben Quellcode -Redakteure Dies kann die Ausrichtung und das visuelle Erscheinungsbild von Text in Kommentaren automatisieren.

Softwareberater und Technologiekommentator Allen Holub^[35] ist ein Experte, der sich dafür einsetzt, die linken Ränder von Kommentaren auszurichten:^[36]

 /* Dies ist der von Holub für C und C ++ empfohlene Stil.   * Es wird in Regel 29 in "Genug Seil" demonstriert.   */ 

 /* Dies ist eine andere Möglichkeit, es zu tun, auch in C.  ** Es ist einfacher, bei Redakteuren, die die zweite nicht automatisch einzurufen, einfacher zu tun  ** Durch die letzten Zeilen des Kommentars ein Raum vom ersten.  ** Es wird auch in Holubs Buch in Regel 31 verwendet.  */ 

Die Verwendung von/ * und */als Blockkommentar -Delimiter wurde von PL/I in die B -Programmiersprache geerbt, dem unmittelbaren Vorgänger der C -Programmiersprache.^[37]

Zeilenkommentare

Zeilenkommentare verwenden im Allgemeinen ein willkürliches Abgrenzer oder Sequenz von Token um den Beginn eines Kommentars anzuzeigen, und a Neue Zeile Charakter, um das Ende eines Kommentars anzuzeigen.

In diesem Beispiel wird der gesamte Text aus den ASCII -Zeichen // bis zum Ende der Zeile ignoriert.

// ------------------------- // Dies ist der Kommentarkörper. // ------------------------- 

Oft muss ein solcher Kommentar weit links beginnen und bis zur gesamten Linie erstrecken. In vielen Sprachen ist es jedoch auch möglich, einen Kommentar abzugeben in der Reihe Mit einer Befehlszeile, um ihm einen Kommentar hinzuzufügen - wie in diesem Perl -Beispiel:

drucken $ s . "\n";  # Fügen Sie nach dem Druck einen neuen Charakter hinzu 

Wenn eine Sprache sowohl Zeilenkommentare als auch Block -Kommentare zulässt, können Programmeams eine Konvention entscheiden, wenn sie sie anders verwenden: z. Zeilenkommentare nur für kleinere Kommentare und blockieren Kommentare, um Abstraktionen auf höherer Ebene zu beschreiben.

Stichworte

Programmierer können informell verwenden Stichworte in Kommentaren zur Unterstützung bei der Indexierung gemeinsamer Probleme. Sie können dann möglicherweise mit gemeinsamen Programmierwerkzeugen gesucht werden, wie sie Unix Grep Nützlichkeit oder sogar Syntax-Highlight innerhalb Textredakteure. Diese werden manchmal als "Codetags" bezeichnet^[38][39] oder "Token".^[40]

Solche Tags unterscheiden sich stark, können jedoch enthalten:

• Bug - ein bekannt Insekt das sollte korrigiert werden.
• Fixme - sollte korrigiert werden.
• Hack - eine Problemumgehung.
• TODO - etwas zu tun.
• HINWEIS - Wird verwendet, um besonders bemerkenswert hervorzuheben Gotchas.
• Rückgängig gemacht - eine Umkehrung oder "Zurück" des vorherigen Code.
• XXX - Warnen Sie andere Programmierer vor problematischen oder fehlgeleiteten Code

Beispiele

Vergleich

Typografische Konventionen zur Angabe von Kommentaren variieren stark. Darüber hinaus bieten einzelne Programmiersprachen manchmal einzigartige Varianten. Für eine detaillierte Bewertung wenden Sie sich bitte an die Programmiersprache Vergleich Artikel.

Ada

Das Ada Die Programmiersprache verwendet '-', um einen Kommentar bis zum Ende der Zeile anzuzeigen.

Zum Beispiel:

  - Die Aufgabe der Flugverkehrskontroller enthält Anfragen zum Start und Landung  Aufgabe Typ Regler (My_runway: Runway_Access) ist  - Aufgabeneinträge für die Synchronnachrichtenübergabe  Eintrag Request_Takeoff (ICH WÜRDE: in Airplane_id; Abheben: aus Runway_Access);  Eintrag Request_Approach(ICH WÜRDE: in Airplane_id; Sich nähern: aus Runway_Access);  Ende Regler; 

Apl

Apl Verwendet ⍝ um einen Kommentar bis zum Ende der Zeile anzuzeigen.

Zum Beispiel:

⍝ Fügen Sie nun die Zahlen hinzu: c←a+b ⍝ Addition 

In Dialekten, die die haben ⊣ ("links") und ⊢ ("rechts") Primitive, Kommentare können oft sein Innerhalb oder separate Aussagen in Form von ignorierten Zeichenfolgen:

d←2×c ⊣'wo'⊢ c←a+ 'gebunden'⊢ b 

Apfelkript

Dieser Abschnitt von Apfelkript Der Code zeigt die beiden in dieser Sprache verwendeten Kommentare.

(* Dieses Programm zeigt einen Gruß an. *) an grüßen(Meine Grüße)  Dialog anzeigen Meine Grüße & " Welt!" Ende grüßen - Zeigen Sie den Gruß grüßen("Hallo") 

BASIC

In diesem Klassiker früh BASIC Code Fragment der REM ("Anmerkung") Das Schlüsselwort wird verwendet, um Kommentare hinzuzufügen.

10 REM Dieses grundlegende Programm zeigt die Verwendung der Aussagen für Druck- und GOTO -Aussagen. 15 REM Es füllt den Bildschirm mit dem Ausdruck "Hallo" 20 DRUCKEN "HALLO" 30 GEHE ZU 20 

Später Microsoft Grundlagen, einschließlich Schnell einfach, Q Basic, Visual Basic, Visual Basic .net, und VB -Skript; und in Nachkommen wie z. Freilasisch und Gambas Jeder Text in einer Zeile nach einem '(Apostroph) -Scharakter wird ebenfalls als Kommentar behandelt.

Ein Beispiel in Visual Basic .net:

Öffentlichkeit Klasse Form 1  Privatgelände Sub Button1_Click(Absender Wie Objekt, e Wie Eventargs) Griffe Taste 1.Klicken  'Der folgende Code wird ausgeführt, wenn der Benutzer  Klicken Sie auf die Schaltfläche im Fenster des Programms.  REM -Kommentare existieren immer noch.  Nachrichtenbox.Zeigen("Hallo Welt") 'Zeigen Sie ein Popup-Fenster mit einem Gruß  Ende Sub Ende Klasse 

C

Dies C Das Codefragment zeigt die Verwendung eines Prolog -Kommentars oder "Block -Kommentar", um den Zweck von a zu beschreiben Bedingte Aussage. Der Kommentar erläutert wichtige Begriffe und Konzepte und enthält eine kurze Signatur des Programmierers, der den Code verfasst hat.

 /*   * Überprüfen Sie, ob wir über unser maximales Prozesslimit sind, aber stellen Sie sicher   * Wurzel ausschließen. Dies ist erforderlich, um das Login und die Anmeldung zu ermöglichen und   * Freunde, um die Prozessgrenze pro Benutzer auf etwas niedrigeres zu setzen   * als die Menge der Prozesse wird ausgeführt. - Rik   */  wenn (atomic_read(&p->Benutzer->Prozesse) > = p->rlim[Rlimit_nproc].rlim_cur   && !fähig(CAP_SYS_ADMIN) && !fähig(CAP_SYS_RESource))   gehe zu BAD_FORK_FREE; 

Seit C99 ist es auch möglich, die // Syntax aus C ++ zu verwenden, was auf einen Einzelzeilen-Kommentar hinweist.

Cisco iOS- und iOS-XE-Konfiguration

Das Ausrufezeichen (!) können verwendet werden, um Kommentare im Konfigurationsmodus eines Cisco -Routers zu markieren, solche Kommentare sind jedoch nicht gerettet zu Nichtflüchtiger Gedächtnis (Das enthält die Startup-Config), noch werden sie vom Befehl "show run" angezeigt.^[41][42]

Es ist möglich, einzulegen für Menschen lesbar Inhalte, der tatsächlich Teil der Konfiguration ist und möglicherweise in der gespeichert werden kann NVRAM Startup-Konfiguration über:

• Der Befehl "Beschreibung", der verwendet wird, um der Konfiguration einer Schnittstelle oder von a eine Beschreibung hinzuzufügen BGP Nachbar
• Der Parameter "Name", um einer statischen Route eine Bemerkung hinzuzufügen
• Der Befehl "Bemerkung" in Zugriffslisten

! Fügen Sie den folgenden Text ein, um den Verkehr manuell zu leiten.

Coldfusion

Coldfusion Verwendet Kommentare ähnlich wie HTML -Kommentare, aber anstelle von zwei Strichen verwendet es drei. Diese Kommentare werden von der Coldfusion -Engine gefangen und nicht im Browser gedruckt.

       Hallo Welt<Br />   

Forran IV

Dies Forran IV Codefragment zeigt, wie Kommentare in dieser Sprache verwendet werden, die sehr spaltenorientiert ist. Ein Buchstaben "C" in Spalte 1 bewirkt, dass die gesamte Zeile als Kommentar behandelt wird.

C C Zeilen, die mit 'C' beginnen (in der ersten oder 'Kommentar' Spalte) sind Kommentare C    SCHREIBEN (6,610)   610 FORMAT(12H HALLO WELT)    ENDE 

Beachten Sie, dass die Spalten einer Linie ansonsten als vier Felder behandelt werden: 1 bis 5 ist das Etikettenfeld, 6 führt dazu, dass die Linie als Fortsetzung der vorherigen Aussage angenommen wird. und Deklarationen und Aussagen gehen in 7 bis 72.

Forran 90

Dies Forran Codefragment zeigt, wie Kommentare in dieser Sprache verwendet werden, wobei die Kommentare selbst die grundlegenden Formatierungsregeln beschreiben.

! * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * Jedoch jedoch jedoch jedoch jedoch jedoch nicht nicht nichts ! * Alle Zeichen nach einem Ausrufezeichen werden als Kommentare angesehen * ! * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * * Jedoch jedoch jedoch jedoch jedoch jedoch nicht nicht nichts Programm comment_test  drucken '(EIN)', 'Hallo Welt' ! Fortran 90 führte die Option für Inline -Kommentare vor. Endprogramm 

Haskell

Zeilenkommentare in Haskell beginnen mit '-' (zwei Bindestrichen) bis zum Ende der Zeile, und mehrere Zeilenkommentare beginnen mit '{-' und enden mit '-}'.

{- Dies ist ein Kommentar auf mehr Zeilen -} - Und das ist ein Kommentar zu einer Zeile putstrln "Wikipedia"  - Dies ist ein weiterer Kommentar 

Haskell bietet auch a Lemerkörperprogrammierung Kommentarmethode als "Vogelstil" bekannt.^[43] In diesem Zeilen werden alle Zeilen mit> als Code interpretiert, alles andere wird als Kommentar angesehen. Eine weitere Anforderung ist, dass Sie immer eine leere Zeile vor und nach dem Codeblock hinterlassen:

Im Vogelstil müssen Sie vor dem Code einen Leerzeichen lassen.> Tatsache :: Ganze Zahl -> Ganze Zahl > Tatsache 0 = 1 > Tatsache (n+1) = (n+1) * Tatsache n Und Sie müssen auch nach dem Code eine leere Zeile hinterlassen.

Lemerkundige Programmierung kann auch in Haskell verwendet werden Latex. Die Codeumgebung kann anstelle des Richard Bird's -Stils verwendet werden: in Latex Stil Dies entspricht dem obigen Beispiel. Die Codeumgebung könnte in der Latex -Präambel definiert werden. Hier ist eine einfache Definition:

\ Usepackage{wörtlich} \neue Umgebung{Code} {\wörtlich} {\ endverbatim} 

später im

% Die Latex -Quelldatei Das \Verb| Fakt N | Funktionsaufruf berechnet $n!$ wenn $n\ Ge 0$Hier ist eine Definition:\\ \Start{Code} Tatsache :: Ganze Zahl -> Ganze Zahl Tatsache 0 = 1 Tatsache (n+1) = (n+1) * Tatsache n \Ende{Code} Hier mehr Erklärung mit Verwendung \Latex{} Markup

Java

Dies Java Codefragment zeigt einen Blockkommentar zur Beschreibung der Beschreibung des SettoolTipText Methode. Die Formatierung steht im Einklang mit Sun Microsystems Javadoc Standards. Der Kommentar soll vom Javadoc -Prozessor gelesen werden.

/**  * Dies ist ein Blockkommentar in Java.  * Die SettoolTipText -Methode registriert den Text, der in einem Werkzeugspitzen angezeigt wird.  * Der Text wird angezeigt, wenn der Cursor über die Komponente bleibt.  *  * @param text die zu angezeigte Zeichenfolge. Wenn 'Text' null ist,  * Die Werkzeugspitze ist für diese Komponente ausgeschaltet.  */ Öffentlichkeit Leere SettoolTipText(Saite Text) {  // Dies ist ein Inline -Kommentar in Java. TODO: Schreiben Sie Code für diese Methode. } 

JavaScript

JavaScript Verwendet //, um Kommentaren und / * * / für Mehrzeilen-Kommentare vorzugehen.

// Ein einzelner Zeilen -JavaScript -Kommentar var Inum = 100; var itwo = 2; // ein Kommentar am Ende der Zeile /* Multi-Line JavaScript -Kommentar */ 

Lua

Das Lua Programmiersprache verwendet Doppelhyphens, --, für einzelne Zeilenkommentare in ähnlicher Weise wie Ada, Eiffel, Haskell, Sql und VHDL Sprachen. Lua hat auch Blockkommentare, die mit beginnen --[[ und rennen bis zu einem Schließen ]]

Zum Beispiel:

-[[eine Multi-Linie langer Kommentar ]] drucken(20)  - Drucken Sie das Ergebnis aus 

Eine gemeinsame Technik, um ein Stück Code zu kommentieren,^[44] ist den Code zwischen beizulegen --[[ und--]], wie nachstehend:

--[[ Druck (10) --]] - Keine Aktion (kommentiert) 

In diesem Fall ist es möglich, den Code durch Hinzufügen eines einzelnen Bindestrichs zur ersten Zeile zu reaktivieren:

---[[ drucken(10) --]] -> 10 

Im ersten Beispiel die --[[ In der ersten Zeile beginnt ein langer Kommentar, und die beiden Bindestriche in der letzten Zeile befinden sich noch in diesem Kommentar. Im zweiten Beispiel die Sequenz ---[[ Startet einen gewöhnlichen Einzelkommentar, so dass die ersten und letzten Zeilen unabhängige Kommentare werden. In diesem Fall die drucken ist äußere Kommentare. In diesem Fall wird die letzte Zeile zu einem unabhängigen Kommentar, wie sie mit beginnt --.

Lange Kommentare in Lua können komplexer sein als diese, wie Sie im Abschnitt "Long Strings" C.F. Programmierung in Lua.

Matlab

Im MatlabDie Programmiersprache "%" zeigt einen einzelnen Kommentar an. Mehrzeilen -Kommentare sind auch über%{und%} Klammern verfügbar und können verschachtelt werden, z.

% Dies sind die Derivate für jeden Begriff d = [0 -1 0]; %{  %{     (Beispiel eines verschachtelten Kommentars, Einrückung ist für Kosmetika (und ignoriert).)  %}   Wir bilden das Reihenfolge, folgen das Taylor Formel.   Notiz das wir'betreffend Betriebs an a Vektor. %} seq = d .* (x - c).^n .(Fakultät(n)) % Wir addieren, um die Taylor-Näherung zu erhalten ca. = Summe(seq) 

Nim

Nim Verwendet das Zeichen "#" für Inline -Kommentare. Multi-Line-Block-Kommentare werden mit '#[' geöffnet und mit ']#' geschlossen. Multi-Line-Block-Kommentare können verschachtelt werden.

Nim hat auch Dokumentationskommentare, die gemischt verwenden Markdown und Umstrukturiertertext Markups. Die Kommentare der Inline-Dokumentation verwenden '##' und Multi-Line-Block-Dokumentation Kommentare werden mit '## [' geöffnet und mit '] ##' geschlossen. Der Compiler kann erzeugen Html, Latex und JSON Dokumentation aus den Dokumentationskommentaren. Dokumentationskommentare sind Teil der Zusammenfassung Syntaxbaum und kann mit Makros extrahiert werden.^[45]

## Dokumentation des Moduls*restructuredText*und ** markdown ** # Dies ist ein Kommentar, aber es ist kein Dokumentationskommentar. Typ Kätzchen = Objekt  ## Dokumentation des Typs  das Alter: int  ## Dokumentation des Feldes Proc Schnurren(selbst: Kätzchen) =  ## Funktionsdokumentation  Echo "Schnurren schnurr"  # Dies ist ein Kommentar, aber es ist kein Dokumentationskommentar. # Dies ist ein Kommentar, aber es ist kein Dokumentationskommentar. 

Ocaml

Ocaml Verwendet nestable Kommentare, was beim Kommentieren eines Codeblocks nützlich ist.

Kodeline(*Kommentarstufe 1 (*Kommentarstufe 2*)*) 

Pascal

In Niklaus Wirth's Pascal Sprachfamilie (einschließlich Modula-2 und Oberon), Kommentare werden mit '(*' geöffnet und mit '*)' abgeschlossen.

zum Beispiel:

( * Testdiagonale *) Säule : = TestColumn - Säule; wenn (die Zeile + Säule = Testrow) oder  ....... 

In modernen Dialekten von Pascal werden stattdessen '{' und '}' verwendet.^[46]

Perl

Zeilenkommentare in Perl, und viele weitere SkriptsprachenBeginnen Sie mit einem Hash (#) -Symbol.

# Ein einfaches Beispiel #  mein $ s = "Wikipedia"; # Setzt die Variablen S auf "Wikipedia". drucken $ s . "\n";  # Fügen Sie nach dem Druck einen neuen Charakter hinzu 

Anstelle eines regulären Block -Kommentarkonstrukts verwendet Perl Einfache alte Dokumentation, eine Markup -Sprache für Lemerkörperprogrammierung,^[47] zum Beispiel:^[48]

= Item Pod :: List-e <Gt> new () Erstellen Sie ein neues Listenobjekt. Eigenschaften können durch einen Hash festgelegt werden Referenz wie diese:   meine $ list = pod :: list-> new ({-start => $., -Indent => 4}); Einzelheiten finden Sie in den einzelnen Methoden/Eigenschaften. = Schnitt Sub Neu {  mein $ das = Wechsel;  mein $ Klasse = Ref($ das) || $ das;  mein %Parames = @_;  mein $ sich selbst = {%Parames};  segnen $ sich selbst, $ Klasse;  $ sich selbst->initialisieren();  Rückkehr $ sich selbst; } 

R

R Nur unterstützt Inline -Kommentare, die vom Hash (#) -Scharakter gestartet wurden.

# Dies ist ein Kommentar drucken("Dies ist kein Kommentar")  # Dies ist ein weiterer Kommentar 

Raku

Raku (Zuvor als Perl 6 genannt) verwendet die gleichen Zeilenkommentare und POD -Dokumentationskommentare wie regelmäßig Perl (Siehe Abschnitt "Perl oben)), fügt jedoch einen konfigurierbaren Block-Kommentar-Typ hinzu:" Multi-Line / Embedded-Kommentare ".^[49]

Diese beginnen mit einem Hash -Charakter, gefolgt von einem Backtick und dann einem Eröffnungsschwerpunkt und enden mit dem passenden Schlussklammercharakter.^[49] Der Inhalt kann nicht nur mehrere Zeilen umfassen, sondern auch eingebettet werden.

#`{{" kommentieren "diese Version  Toggle-Case (str: d $ s) Schaltet den Fall jedes Zeichens in einer Zeichenfolge um:   mein Str $ toggled-String = Toggle-Case ("Mein Name ist Michael!"); }} Sub Schaltkase(Str: d $ s) #`(Diese Version von Parens wird jetzt verwendet){...}

Php

Kommentare in Php Kann entweder im C ++ - sowohl im Inline- als auch im Block) oder Hashes verwendet werden. Phpdoc ist ein aus Javadoc adaptierter Stil und ist ein üblicher Standard für die Dokumentation von PHP -Code.

Power Shell

Kommentare in Windows PowerShell

# Single -Line -Kommentar Schreibhost "Hallo Welt!" <# Multi    Linie    Kommentar #> Schreibhost "Auf Wiedersehen Welt!" 

Python

Inline -Kommentare in Python Verwenden Sie das Hash (#) -Scharakter, wie in den beiden Beispielen in diesem Code:

# Dieses Programm druckt "Hello World" auf den Bildschirm drucken("Hallo Welt!")  # Beachten Sie die neue Syntax 

Block -Kommentare, wie in diesem Artikel definiert, gibt es in Python technisch nicht.^[50] Ein nackter Saitenliteral dargestellt durch eine dreifache Zeichenfolge kann verwendet werden,^[51] wird aber vom Dolmetscher nicht genauso ignoriert, wie der Kommentar "#" ist.^[50] In den folgenden Beispielen handeln die dreifachen doppelt zitierten Strings auf diese Weise wie Kommentare, werden aber auch als als behandelt Docstrings:

"" " Angenommen, dies ist Datei myModule.py, dann diese Zeichenfolge, die die Die erste Anweisung in der Datei wird das "MyModule" -Modul docString, wenn die Datei importiert wird. "" " Klasse Meine Klasse:  "" Die Dokus der Klasse "" ""  def my_method(selbst):  "" Die Methode docstring "" "" def my_function():  "" Die Funktion der Funktion "" "" 

Rubin

Kommentare in Rubin.

Einzelzeilen -Kommentar: (Zeile beginnt mit Hash "#")

stellt "Dies ist kein Kommentar" # Dies ist ein Kommentar stellt "Dies ist kein Kommentar" 

Multi-Line-Kommentar: (Kommentare zwischen Keywords "Beginn" und "End")

stellt "Dies ist kein Kommentar" = Beginnen Sie Was auch immer in diesen Zeilen geht ist nur für den menschlichen Leser = Ende stellt "Dies ist kein Kommentar" 

Sql

Standard-Kommentare in SQL sind nur in Einzelzeilen in nur einen Zeilenform, in dem zwei Striche verwendet werden:

- Dies ist ein einzelner Zeilenkommentar - gefolgt von einer zweiten Zeile AUSWÄHLEN ZÄHLEN(*)  AUS Autoren  WO Autoren.Name = 'Schmied'; - Hinweis: Wir wollen nur 'Smith'  - Dieser Kommentar erscheint nach SQL-Code 

Alternativ wird eine Kommentarformatsyntax identisch mit dem in der Syntax für C und Java verwendeten "Block Comment" -Stil wird von unterstützt Transact-SQL, Mysql, Sqlite, PostgreSQL, und Orakel.^{[52][53][54][55][56]}

MySQL unterstützt auch Kommentare des Hash (#) -Scharakters bis zum Ende der Zeile.

Schnell

Einzelzeilenkommentare beginnen mit zwei Vorwärtsschwellen (//):

// Dies ist ein Kommentar. 

Multiline-Kommentare beginnen mit einem Vorwärtsschlag, gefolgt von einem Sternchen (/*) und enden mit einem Stern, gefolgt von einem Vorwärtsschlag (*/):

/* Dies ist auch ein Kommentar  ist aber über mehrere Zeilen geschrieben. */ 

Multiline -Kommentare in Swift können in anderen Multiline -Kommentaren verschachtelt werden. Sie schreiben verschachtelte Kommentare, indem Sie einen Multiline -Kommentarblock starten und dann einen zweiten Multiline -Kommentar innerhalb des ersten Blocks starten. Der zweite Block wird dann geschlossen, gefolgt vom ersten Block:

/* Dies ist der Beginn des ersten Multiline -Kommentars.  /* Dies ist der zweite verschachtelte Multiline -Kommentar. */  Dies ist das Ende des ersten Multiline -Kommentars. */ 

XML (oder HTML)

Kommentare in Xml (oder HTML) werden mit eingeführt

  Name ="Kontext" Wert ="Öffentlichkeit" /> 

Für Kompatibilität mit SGML, Die String "-" (Double-Hyphen) ist in Kommentaren nicht erlaubt.

Sicherheitsprobleme

Im interpretierte Sprachen Die Kommentare sind für den Endbenutzer des Programms angezeigt. In einigen Fällen, wie z. B. Codeabschnitte, die "kommentiert" werden, kann dies eine Sicherheit darstellen Verletzlichkeit.^[57]

Siehe auch

• Docstring, eine bestimmte Art von Kommentar, die während der Laufzeit des Programms analysiert und beibehalten wird.
• Shebang, die Verwendung von #! Als Interpreter-Richtlinie in Skripten auf Unix-ähnlichen Systemen
• HTML -Kommentar -Tag
• Lemerkörperprogrammierung, alternative Dokumentation Paradigma
• Syntax von Kommentaren In verschiedenen Programmiersprachen

Notizen und Referenzen

Weitere Lektüre

• Movshovitz-Attias, Dana und Cohen, William W. (2013) Natürliche Sprachmodelle für die Vorhersage von Programmierkommentaren. In Association for Computational Linguistics (ACL), 2013.

Externe Links

• Wie schreibe ich Kommentare von Denis Krukovsky
• Quellcode -Dokumentation als Live -Benutzerhandbuch von ptlogica
• So schreiben Sie Kommentare für das Javadoc -Tool