Ich habe eine Frage bezüglich der Programmierung und der englischen Sprache: Ob man die dritte Person oder den Imperativ benutzt, wenn man einzelne Codezeilen kommentiert. Nehmen Sie die folgende Codezeile in einer imperativen Sprache an, die kommentiert werden sollte:
%Vor%Mein Ansatz, um diese Zeile zu kommen, wäre, den Kommentar mit einer dritten Person so zu setzen, dass dies ein gewöhnlicher englischer Satz wäre, der die Zeile als Betreff enthält:
%Vor%Da wir aber in einer imperativen Sprache sind und den Computer so "befehligen", könnte man sogar daran denken, den Kommentar vor den Code zu stellen und imperativ zu verwenden:
%Vor%Dies ist sogar nützlich, wenn mehrere Zeilen miteinander kommentiert werden müssen.
Ich persönlich bevorzuge den ersten Stil, aber ich bin oft unsicher, welchen Stil ich verwenden soll. Es wäre großartig, wenn einige ihre persönlichen Erfahrungen hier niederschreiben könnten.
Der erste Ansatz ist definitiv die geeignetere Methode zum Kommentieren, da es Leute sein werden, die Ihre Kommentare lesen, es ist wichtig, dass sie so einfach zu lesen sind, wie es möglich ist. //Do something klingt, als würden Sie mit dem Computer sprechen, anstatt zu erklären, was der Code tut.
Der offizielle Stilführer von Oracle besagt:
Verwenden Sie die 3. Person (deskriptiv) nicht die 2. Person (präskriptiv). Die Beschreibung ist in der 3. Person deklarativ und nicht in der 2. Person erforderlich.
Ruft die Bezeichnung ab. (bevorzugt)
Holen Sie sich das Etikett. (vermeiden)
Oracles Styleguide finden Sie hier .
Tags und Links coding-style comments