Ich bin dabei, ein Projekt zu verlassen, und bevor ich gehe, hat mein Chef mich gebeten, Code zu dokumentieren (ich habe nicht sehr gut dokumentiert). Es ist keine große Sache, das Projekt ist nicht besonders komplex. Aber ich finde in meiner Dokumentation Stellen, an denen ich sagen möchte:...
Diese Frage beschäftigt mich seit 2 Monaten. Vor einiger Zeit gab mir ein Freund, der ein großartiger Programmierer ist, einige Beispielcodes, und zum ersten Mal bemerkte ich einen einzigartigen Stil beim Organisieren von Kommentaren. Er bemühte sich, Kommentare so zu gestalten, dass ich mich mit...
Ich bin gerade in einem Laborhandbuch an der Universität auf Folgendes gestoßen: Sie müssen die Schnittstellen der Klassen studieren, indem Sie das Javadoc für sie generieren, damit Sie wissen, welche Operationen bereitgestellt werden (Sie können sich den Code ansehen, aber wenn Sie wie hier den...
Möchten Sie diesen Beitrag verbessern? Geben Sie detaillierte Antworten auf diese Frage, einschließlich Zitaten und einer Erklärung, warum Ihre Antwort richtig ist. Antworten ohne ausreichende Details können bearbeitet oder gelöscht werden. Ich bin ein
Ich lerne, wie man Parser mit Grammatiken erstellt, aber ich habe versucht, Kommentare auszudrücken, weil sie fast überall erscheinen können. Dies zeigt an, dass Kommentare aus dem Token-Stream entfernt werden können, bevor das Parsen stattfindet. Ist das die Standardpraxis oder werden Kommentare...
Hin und wieder hinterlasse ich Kommentare wie # We only need to use the following for V4 of the computation. # See APIPROJ-14 for details. oder # We only need to use the following for V4 of the computation. # See https://theboringcompany.atlassian.net/browse/DIGIT-827 for details. Mein...
<body> <!-- wrapper --> <div id="wrapper"> <!-- title --> <div id="title"><img src="title.png" alt="" /></div> <!-- form wrapper --> <div id="form_wrapper"> <!-- form --> <form action="thankyou.php" method="POST">...
Aus mehreren Gründen kommentiere ich während der Entwicklung manchmal Code aus. Da ich chaotisch bin und es manchmal eilig habe, schaffen es einige von ihnen zur Quellcodeverwaltung. Ich benutze auch Kommentare, um Codeblöcke zu klären. Zum Beispiel: MyClass MyFunction() { (...) // return null; //...
Ich weiß nicht, ob dies bei den meisten Opensource-Bibliotheken der Fall ist, aber viele von mir kennen und verwenden (z. B. OpenSSL, Webkit, ...), denen alle Kommentare fehlen oder die nur sehr wenige Kommentare enthalten. Ganz zu schweigen von den wenigen Dokumenten, deren Quellcode schwer zu...