Justin Duke fragt, ob das Behandeln von Code-Kommentaren wie Fußnoten uns helfen könnte, den Code in einer Datei besser zu verstehen. In seinem Mockup sind alle Kommentare standardmäßig ausgeblendet und erfordern einen Klick, um sie anzuzeigen.
Was für eine tolle Idee! Justins Design erinnert mich daran, wie Instapaper Inline-Fußnoten behandelte.
Ich schätze, der Grund, warum mir diese Idee so gut gefällt, ist, dass viele Kommentare nicht ständig gelesen werden müssen – sie sind eine Art Erinnerung daran: „Hey, das muss in Zukunft noch bearbeitet werden“ oder „Igitt, das ist seltsam und es tut mir leid.“ Wenn diese Kommentare aus dem Code entfernt werden, ist es auch viel einfacher, die gesamte Datei zu scannen.
Ich frage mich, ob es einen Schalter geben könnte, der alle Kommentare anzeigt, nur für den Fall, dass Sie alle Kommentare in der richtigen Reihenfolge lesen müssen, anstatt auf jeden einzelnen zu klicken, um ihn ein- oder auszublenden.
Wie auch immer, all dieses Gerede über Kommentare erinnert mich an einen absolut fantastischen Vortrag von Sarah Drasner auf der JSConf dieses Jahr, in dem sie diskutierte, warum Kommentare so schwer richtig hinzubekommen sind.
Eine weitere Meinung, wie man Kommentare schreibt (oder nicht schreibt): https://blog.usejournal.com/stop-writing-code-comments-28fef5272752
Es ist eine starke Meinung, aber nachdem ich angefangen habe, dem zu folgen, sehe ich eine Verbesserung meines Codes. Er ist selbsterklärender als zuvor.
So etwas könnte auch robustere Kommentare fördern, da man mehr Informationen schreiben könnte, ohne viel visuellen Platz im Code einzunehmen. Das gefällt mir! Die einzige Änderung, die ich vorschlagen würde, wäre eine Art von Syntax für bestimmte Kommentare, damit sie nicht kollabieren. Manchmal verwende ich Kommentare als Abschnittsüberschriften innerhalb langer HTML- oder CSS-Dokumente, und es wäre schön, diese anzuzeigen, während beschreibende Kommentare zu bestimmten Code-Teilen ausgeblendet werden.
Manchmal ist der Code komplex, macht aber etwas Einfaches. In diesem Fall dienen Kommentare eher als kurze Erklärungen denn als Fußnoten, daher müssen sie sichtbar sein.
Die Prämisse guten Programmierstils, der keine Kommentare benötigt, klingt großartig, aber in Wirklichkeit sind die Kommentare nicht dazu da, Ihnen heute zu helfen, sondern in 3 Jahren, wenn Sie zum Code zurückkehren und verstehen müssen, was Sie versucht haben zu tun.
Ich habe so viele Fälle gesehen, in denen Leute fälschlicherweise == anstelle von != verwendet haben. Und Sie debuggen den Code und versuchen zu verstehen, ob sie das meinten oder nicht. Ein einfacher Kommentar wie
// Wenn der Zustand nicht leer ist, tue…
kann lebensrettend sein.
Ich mag die Idee, Kommentare in einen ausklappbaren Bereich zu legen.
Ich bin eigentlich sehr an der Umkehrung interessiert. Etwas, das sich Literate Programming nennt. Betrachten Sie es als das Schreiben einer Markdown-Datei mit Code-Schnipseln darin.
https://de.wikipedia.org/wiki/Literate_Programming
https://github.com/Rich-Harris/lit-node