Das folgende Programm verwendet nur wenige der wichtigen Tags, die für Dokumentationskommentare verfügbar sind. Sie können andere Tags basierend auf Ihren Anforderungen verwenden. Die Java-Sprache unterstützt drei Arten von Kommentaren – Die folgenden Codefragmente in C zeigen nur ein winziges Beispiel dafür, wie Kommentare stilistisch variieren können, während sie dennoch die gleichen grundlegenden Informationen vermitteln: Viele IDEs ermöglichen das schnelle Hinzufügen oder Entfernen solcher Kommentare mit einzelnen Menüoptionen oder Tastenkombinationen. Der Programmierer muss nur den Teil des Textes markieren, den er (un)kommentieren möchte, und die entsprechende Option auswählen. 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: Insbesondere viele Software-Betreuer setzen Einreichungsrichtlinien in Kommentare, um Menschen, die den Quellcode dieses Programms lesen, zu helfen, alle Verbesserungen, die sie machen, zurück an den Betreuer zu senden. Es gibt viele stilistische Alternativen zur Verfügung, wenn sie überlegen, wie Kommentare im Quellcode erscheinen sollten. Bei größeren Projekten, an denen ein Entwicklerteam beteiligt ist, werden Kommentarstile entweder vereinbart, bevor ein Projekt gestartet wird, oder sich im Rahmen der Erweiterung eines Projekts als Konvention oder Bedarf weiterentwickeln. In der Regel bevorzugen Programmierer Stile, die konsistent, nicht obstruktiv, leicht zu ändern und schwer zu brechen sind.

[34] ColdFusion verwendet Kommentare, die HTML-Kommentaren ähneln, aber anstelle von zwei Bindestrichen werden drei verwendet. Diese Kommentare werden von der ColdFusion-Engine abgefangen und nicht im Browser gedruckt. Wie man am besten auf Kommentare setzt, ist umstritten; verschiedene Kommentatoren haben unterschiedliche und manchmal gegensätzliche Standpunkte angeboten. [7] [8] Es gibt viele verschiedene Arten, Kommentare zu schreiben, und viele Kommentatoren bieten widersprüchliche Ratschläge an. [8] Godoc ist konzeptionell mit Pythons Docstring und Javadoc von Java doc verwandt, aber sein Design ist einfacher. Die von godoc gelesenen Kommentare sind keine Sprachkonstrukte (wie bei Docstring) und müssen auch keine eigene maschinenlesbare Syntax haben (wie bei Javadoc). Godoc-Kommentare sind nur gute Kommentare, die Art, die Sie lesen möchten, auch wenn godoc nicht existierte. Ein Beispiel für das Kommentieren von Code für Ausschlusszwecke ist unten: Manchmal vergessen wir als Entwickler, dass wir Kommentare schreiben, damit Menschen sie lesen können. Alle Programmiersprachen, die wir verstehen, sind für Maschinen gebaut, so dass es mühsam sein kann, in klar geschriebenen Text umzuwandeln. Es ist wichtig zu beachten, dass wir nicht hier sind, um ein Forschungspapier auf College-Niveau zu schreiben, sondern nur Tipps zu hinterlassen! OCaml verwendet verschachtelbare Kommentare, was beim Kommentieren eines Codeblocks nützlich ist. Wir können nicht alle stundenlang vor dem Computer sitzen und Code schreiben.

Liked it? Take a second to support frostclaw on Patreon!