von phi » Mi 18. Mär 2009, 00:58
Gewitterbukk hat geschrieben:Ich habe heute wieder einiges mit LaTeX gemacht. Dabei stellte sich mir mal wieder eine Frage, die ich kaum zu stellen wage weil sie wahrscheinlich etwas, naja, dumm ist. Warum werden eigentlich einige Zeilen mit einem %-Zeichen, also Kommentarzeichen beendet? Mir ist das jetzt schon öfter aufgefallen. Wann und warum macht man das oder sollte man das machen?
Die Situation ist etwas kompliziert, aber in den meisten Fällen ist ein einzelner Zeilenumbruch für TeX identisch zu einem einzelnen Leerzeichen. Ebenso ist jede Kombination aus Leerzeichen, Tabulatoren und höchstens einem Zeilenubruch identisch mit einem Leerzeichen. An bestimmten Stellen werden Leerzeichen ignoriert, z.B. nach Befehlsnamen (damit es überhaupt eine Möglichkeit gibt, das Ende eines Befehlsnamens anzuzeigen). Deshalb fügt beispielsweise der Code
vor dem TeX-Logo ein Leerzeichen ein, danach aber nicht. Nun will man häufig Leerzeichen unterdrücken, aber trotzdem aufgrund der Übersichtlichkeit Zeilenumbrüche einfügen. In diesem Fall beendet man die Zeile mit einem Kommentarzeichen, welches den Zeilenumbruch und alle Leerzeichen und Tabulatoren am Anfang der nächsten Zeile auskommentiert.
Gewitterbukk hat geschrieben:Da ich meinen Stil beim Schreiben von LaTeX-Code gerne verbessern würde, wäre ich generell froh über Tips und Anregungen dazu. Wie macht ihr das so? Gibt es da Empfehlungen oder vlt sogar Vorschriften?
Das ist eine viel zu allgemeine Frage, da könnte man stundenlang drüber reden. Einige häufige Fehler sind im Dokument
l2tabu beschrieben. Dabei geht es vor allem um veraltete oder typografisch fragwürdige Konstrukte, aber eine erschöpfende Diskussion ist das natürlich nicht. In LaTeX hat man natürlcih den Vorteil, dass man durch schlechten Stil weder Abstürze noch Sicherheitslücken erzeugen kann, deswegen wird schlechter Stil nicht als sehr kritisch angesehen. Meiner Meinung lernt man am besten dadurch guten Stil, dass man einerseits selber schreibt und andererseits sich positive Beispiele anschaut. Generell gilt für die guten Beispiele: Je neuer, desto besser, da frühere Autoren mehr Wert auf niedrige Kompilationszeiten gelegt und dadurch so manchen Hack eingebaut haben. Die meisten Anleitungen der neueren, weit verbreiteten Klassen und Paketen (KOMA-Script, memoir, beamer, TikZ...) dürften gut geeignet sein.
[quote="Gewitterbukk"]Ich habe heute wieder einiges mit LaTeX gemacht. Dabei stellte sich mir mal wieder eine Frage, die ich kaum zu stellen wage weil sie wahrscheinlich etwas, naja, dumm ist. Warum werden eigentlich einige Zeilen mit einem %-Zeichen, also Kommentarzeichen beendet? Mir ist das jetzt schon öfter aufgefallen. Wann und warum macht man das oder sollte man das machen?[/quote]Die Situation ist etwas kompliziert, aber in den meisten Fällen ist ein einzelner Zeilenumbruch für TeX identisch zu einem einzelnen Leerzeichen. Ebenso ist jede Kombination aus Leerzeichen, Tabulatoren und höchstens einem Zeilenubruch identisch mit einem Leerzeichen. An bestimmten Stellen werden Leerzeichen ignoriert, z.B. nach Befehlsnamen (damit es überhaupt eine Möglichkeit gibt, das Ende eines Befehlsnamens anzuzeigen). Deshalb fügt beispielsweise der Code[code]a \TeX b[/code]vor dem TeX-Logo ein Leerzeichen ein, danach aber nicht. Nun will man häufig Leerzeichen unterdrücken, aber trotzdem aufgrund der Übersichtlichkeit Zeilenumbrüche einfügen. In diesem Fall beendet man die Zeile mit einem Kommentarzeichen, welches den Zeilenumbruch und alle Leerzeichen und Tabulatoren am Anfang der nächsten Zeile auskommentiert.
[quote="Gewitterbukk"]Da ich meinen Stil beim Schreiben von LaTeX-Code gerne verbessern würde, wäre ich generell froh über Tips und Anregungen dazu. Wie macht ihr das so? Gibt es da Empfehlungen oder vlt sogar Vorschriften?[/quote]Das ist eine viel zu allgemeine Frage, da könnte man stundenlang drüber reden. Einige häufige Fehler sind im Dokument [url=http://ctan.org/pkg/l2tabu]l2tabu[/url] beschrieben. Dabei geht es vor allem um veraltete oder typografisch fragwürdige Konstrukte, aber eine erschöpfende Diskussion ist das natürlich nicht. In LaTeX hat man natürlcih den Vorteil, dass man durch schlechten Stil weder Abstürze noch Sicherheitslücken erzeugen kann, deswegen wird schlechter Stil nicht als sehr kritisch angesehen. Meiner Meinung lernt man am besten dadurch guten Stil, dass man einerseits selber schreibt und andererseits sich positive Beispiele anschaut. Generell gilt für die guten Beispiele: Je neuer, desto besser, da frühere Autoren mehr Wert auf niedrige Kompilationszeiten gelegt und dadurch so manchen Hack eingebaut haben. Die meisten Anleitungen der neueren, weit verbreiteten Klassen und Paketen (KOMA-Script, memoir, beamer, TikZ...) dürften gut geeignet sein.