Guter Stil für Makro in .sty

Antwort erstellen


Diese Frage dient dazu, das automatisierte Versenden von Formularen durch Spam-Bots zu verhindern.
Smilies
:D :) :( :o :shock: :? 8) :lol: :-x :P :oops: :cry: :evil: :twisted: :roll: :wink: :!: :?: :idea: :arrow: :| :mrgreen:

BBCode ist eingeschaltet
[img] ist eingeschaltet
[flash] ist ausgeschaltet
[url] ist eingeschaltet
Smilies sind eingeschaltet

Die letzten Beiträge des Themas

Ich habe die Datenschutzerklärung gelesen und bin damit einverstanden.

   

Wenn du eine Datei oder mehrere Dateien anhängen möchtest, gib die Details unten ein.

Ansicht erweitern Die letzten Beiträge des Themas: Guter Stil für Makro in .sty

von Gast » Fr 23. Feb 2018, 07:42

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.

Guter Stil für Makro in .sty

von oplo » Do 22. Feb 2018, 22:23

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:
\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)

Nach oben