Guter Stil für Makro in .sty

Redefinition von Makros, Definition eigener Befehle sowie neuer Umgebungen


oplo

Guter Stil für Makro in .sty

Beitrag von oplo »

Hallo,


ich schreibe zum ersten Mal eine .sty-Datei.
Ich würde in der .sty gerne Makros verwenden, um die Lesbarkeit des Codes zu erleichtern.
Ist \newcommand die richtige Definition für Makros?
ZB:

Code: Alles auswählen

\newcommand{\kurzeVersion}{Dies ist die lange Versions.
                          \clearpage}
Nur, dieses \newcommand ist ja nur für die .sty relevant, und sie sollte nicht im document benutzt werden.
Kann man das \newcommand irgendwie private machen?
Oder wie ist der schönste Stil in solchen Fällen bei .sty-Dateien?


Danke
(das geht sicher ohne Minimal-Bsp)

Gast

Beitrag von Gast »

So etwas wie private Namen gibt es bei TeX nicht. Es ist jedoch LaTeX-Konvention interne Makros mit einem @ zu versehen. Darüber hinaus hat sich eingebürgert, dass man entweder den Paketnamen oder eine Kurzform davon als Präfix verwendet. So finden sich in KOMA-Script beispielsweise diverse Makros, die mit \scr@ beginnen, in hyperref ist es Hy@, in beamer in geradezu vorbildlicher Weise \beamer@.

Eventuell willst Du auch direkt mit LaTeX3 anfangen. Dann gibt es in der Doku zu l3kernel den [d]l3styleguide[/d], der erklärt wie man mit Hilfe von l3docstrip sehr einfach Code schreiben kann, der für interne Makros die dortige Namenskonvention umsetzt.

Antworten