Vorlage:Dokumentation/Doku: Unterschied zwischen den Versionen

Vorlage:Dokumentation/Doku (Quelltext anzeigen)

630 Bytes hinzugefügt , 8. November 2007

Begründung und Erklärung

Anonymer Benutzer

@@ Zeile 1: / Zeile 1: @@
 <noinclude>{{Dokumentation/Unterseite}}
-</noinclude>Diese Vorlage zeigt eine Dokumentationsbox wie du sie gerade siehst. Sie bindet den Text von der Unterseite <code><nowiki>[[<Seitenname>/doc]]</nowiki></code> ein. Diese Vorlage sollte bei allen Vorlagen Verwendung finden; die Beschreibung sollte immer aus der eigentlichen Vorlage ausgelagert werden.
+</noinclude>Diese Vorlage zeigt eine Dokumentationsbox wie du sie gerade siehst. Sie bindet den Text von der Unterseite <code><nowiki>[[<Seitenname>/doc]]</nowiki></code> ein.
+Diese Vorlage sollte bei allen Vorlagen Verwendung finden.
+== Begründung ==
+Die Trennung von Programmcode und Dokumentation trägt zur besseren Übersichtlichkeit bei.
+Der Hauptgrund ist jedoch, dass dadurch der Parser entlastet wird. Die Wikipedia setzt die Vorlagen nicht effizient in Bytecode um. Bei jeder Anwendung wird der gesammte Vorlagentext immer wieder neu ausgewertet, samt der Dokumentation, die im Endeffekt eh wieder weggelassen wird. Nichtsdestotrotz werden <code><nowiki><noinclude>s</nowiki></code> vor den aktuellen Einbindungen ausgewertet, so dass man die Pre-expand include size drastisch Drücken kann, wenn man die Dokus für immer in Unterseiten packt. Daher sollte die Beschreibung immer aus der eigentlichen Vorlage ausgelagert werden.
 == Benutzung ==