Gibt es eigentlich verbindliche oder empfehlenswerte Konventionen von Kommentaren?
Ich verwende derzeit ein einfaches % zum An- und Ausschalten einer Codezeile, und kurze Hinweise zu Orientierungen.
Ich verwende derzeit %% um mich mit anderen Codenutzern zu unterhalten, warum ich hier etwas so und nicht anders mache. Also mehr erläuternde Kommentare.
Macht das jemand ähnlich oder anders? Liege ich mit meiner Nutzung richtig? Gibt es andere bzw. weitere Empfehlungen zu Kommentaren im Quellcode?
Was die Formatierung angeht, da orientiere ich mich an der Vorgabe von Frescobaldi, HTML- und JavaScript-Standards. Ich weiß, dass jede Programmier- und Skriptsprache und jede Programmier-Community ihre eigenen Konventionen hat. Ein extra ausführliches Kapitel zu dem Thema habe ich noch nicht in den Dokumentationen entdeckt, was aber nichts heißen muss.
Hallo Mjchael,
ich kenne keine globalen Vorgaben (aber ich kenne gewisse Postscript-Gepflogenheiten mit %%)
Persönlich benutze ich - nur für mich:
- Zu Anfang der Datei »%{«, in den nächsten Zeilen Angaben zum Inhalt, Abschluß des Kommentarkopfes mit »%}« in einer Zeile.
- meistens fünf aufeinanderfolgende %-Zeichen, wenn ich eine noch zu bearbeitende Stelle in der LY-Datei markieren will
- »%PREPROCESS:«, %POSTPROCESS:« und »%CMDLINEOPTS=« (grundsätzlich am Zeilenanfang) werden von dem Script ausgewertet, welches ich zum Übersetzen (per Kommandozeile) nutze. Beispielsweise »PDF-Reader (sumatraPDF) öffnen bzw. die schon geöffnete Datei in den Bildschirmvordergund holen«, »aus der PS-Ausgabe ein Booklet-PDF erzeugen«, »MIDI in WAV und MP3 konvertieren, eventuell danach gleich das Abspielen starten«
Arnold
@Arnold
Klingt vertraut. :)
Zitatfünf aufeinanderfolgende %-Zeichen
Das macht Sinn und ich finde es ebenfalls praktisch.
Ich kommentiere gerne folgenden Tag aus:
%<score>
...
%</score> Das soll denen, die ich um Rat frage, mitteilen, dass ich mit einem Lilypond-Pluggin für die Wikipedia und Wikibooks arbeite, und mit Lösungen, die \includes oder einige andere Elemente enthalten nichts anfangen kann, da bestimmte Funktionen aus Sicherheitsgründen deaktiviert sind. Und um Frescobaldi nicht zu irritieren.
Das folgt einem ähnlichen Prinzip wie dein Hinweis, Steuerungshinweise für externe Programme (wie »%PREPROCESS:«, %POSTPROCESS:« und »%CMDLINEOPTS=« ) zu maskieren, wenn auch auf einem simpleren Niveau.