Formatierung von DokumentationsdateienXML TagsJede Datei des Manuals muss die folgenden XML Deklarationen am Beginn der Datei enthalten:
XML Dateien von übersetzten Sprachen müssen auch ein Revisions Tag enthalten, das mit der Revision der englischen Sprachdatei korrespondiert, auf der die Übersetzung basiert.
Maximale ZeilenlängeDie maximale Zeilenlänge, inklusive Tags, Attribute und Einrückungen, darf 100 Zeichen nicht überschreiten. Es gibt nur eine einzige Ausnahme zu dieser Regel: Attributen und Werte Paaren ist es erlaubt die 100 Zeichen zu überschreiten wenn diese nicht getrennt werden dürfen. EinrückungEine Einrückung sollte aus 4 Leerzeichen bestehen. Tabulatoren sind nicht erlaubt. Tags, welche auf dem gleichen Level sind, müssen auch die gleiche Einrückung haben.
Tags, welche ein Level unter dem vorhergehenden Tag sind, müssen mit 4 zusätzlichen Leerzeichen eingerückt werden.
Mehrere Block Tags in der gleichen Zeile sind nicht erlaubt; mehrere Inline Tags sind trotzdem erlaubt.
ZeilenendekennzeichenDie Zeilenendekennzeichen folgt der Unix Textdatei Konvention. Zeilen müssen mit einem einzelnen Linefeed (LF) Zeichen enden. Linefeed Zeichen werden als ordinale 10, oder Hexadezimale 0x0A repräsentiert. Beachte: Es sind keine Carriage Returns (CR) zu verwenden, welche die Konvention in Apple OS's (0x0D) sind, oder die Carriage Return - Linefeed Kombination (CRLF), welche der Standard für Windows OS (0x0D, 0x0A) sind. Leere TagsLeere Tags sind nicht erlaubt; alle Tags müssen Text oder Untertags enthalten.
Verwendung von Leerzeichen in DokumentenLeerzeichen in TagsÖffnende Block Tags sollten direkt anschliessend keine Leerzeichen haben, sondern nur einen Zeilenumbruch (und Einrückungen in der folgenden Zeile).
Öffnende Inline Tags sollten keine Leerzeichen haben, die direkt folgen.
Schließenden Block Tags können Leerzeichen vorangestellt sein, die dem aktuellen Einrückungslevel entsprechen, aber nicht mehr als diese Anzahl.
Schließenden Inline Tags dürfen keine Leerzeichen vorangestellt sein.
Mehrere ZeilenumbrücheMehrere Zeilenumbrüche innerhalb oder auch zwischen Tags sind nicht erlaubt.
Trennung zwischen TagsTags auf dem gleichen Level müssen durch eine leere Zeile getrennt sein, um die Lesbarkeit zu erhöhen.
Das erste Untertag sollte direkt unterhalb seiner Eltern geöffnet werden, ohne dass eine leere Zeile zwischen ihnen ist; das letzte Untertag sollte direkt vor dem schließenden Tag seiner Eltern geschlossen werden.
Programmcode-AbschnitteDas öffnende <programlisting> Tag muss das richtige "language" Attribut anzeigen und auf dem gleichen Level eingerückt sein wie die vorhergehenden Blöcke.
CDATA sollte um alle Programmcode-Abschnitte vorhanden sein. <programlisting> Abschnitte dürfen keine Zeilenumbrüche oder Leerzeichen am Anfang oder Ende des Abschnitts besitzen, da diese auch in der endgültigen Ausgabe dargestellt werden.
Endende CDATA und <programlisting> Tags sollten in der gleichen Zeile, aber ohne Einrückung stehen.
Das <programlisting> Tag sollte das "language" Attribut mit einem Wert enthalten, der dem Inhalt des Programmcode-Abschnitts entspricht. Typischerweise enthält es die Werte "css", "html", "ini", "javascript", "php", "text", und "xml".
Für Programmcode-Abschnitte, die nur PHP Code enthalten, werden keine PHP-Tags (wie z.B. "<?php", "?>") benötigt, und sollten auch nicht verwendet werden. Sie zeigen nur das Naheliegendste und werden durch die Verwendung des <programlisting> Tags impliziert.
Die Zeilenlängen in Programmcode-Abschnitten sollten den Coding Standard Empfehlungen folgen. require_once(), require(), include_once() und include() sollten innerhalb von PHP-Listings nicht verwendet werden. Sie zeigen nur das Naheliegendste, und sind meistens nicht notwendig, wenn ein Autoloader verwendet wird. Sie sollten nur verwendet werden, wenn sie essentiell für das Beispiel sind.
Notizen zu speziellen Inline TagsclassnameDas Tag <classname> muß jedesmal verwendet werden, wenn ein Klassenname durch sich selbst repräsentiert wird; er sollte nicht in Kombination mit einem Methodennamen, Variablennamen, oder einer Konstante verwendet werden, und auch anderer Inhalt ist nicht innerhalb des Tags erlaubt.
varnameVariablen müssen im <varname> Tag eingeschlossen sein. Variablen müssen mit Verwendung des "$" Siegels geschrieben werden. Kein anderer Inhalt ist innerhalb des Tags erlaubt, ausser es wird ein Klassenname verwendet, der eine Klassenvariable anzeigt.
methodnameMethoden müssen innerhalb des <methodname> Tags stehen. Methoden müssen entweder die komplette Methoden Signatur enthalten, oder zumindest ein Paar schließender Klammern (z.B., "()"). Kein anderer Inhalt ist innerhalb dieses Tags erlaubt, ausser es wird ein Klassenname verwendet, der eine Klassenmethode anzeigt.
constantDas <constant> Tag ist zu verwenden wenn Konstanten angezeigt werden sollen. Konstanten müssen GROßGESCHRIEBEN werden. Kein anderer Inhalt ist innerhalb dieses Tags erlaubt, ausser es wird ein Klassenname verwendet, der eine Klassenkonstante anzeigt.
filenameDateinamen und Pfade müssen im <filename> Tag enthalten sein. Kein anderer Inhalt ist innerhalb dieses Tags erlaubt.
commandCommands, Shell Skripte, und Programmaufrufe müssen im <command> Tag enthalten sein. Wenn das Kommando Argumente enthält sollten diese auch im Tag enthalten sein.
codeDie Verwendung des <code> Tags ist nicht erlaubt. Stattdessen sollten die anderen vorher besprochenen Inline Tags verwendet werden. Notizen zu speziellen Block TagstitleDas <title> Tag darf keine anderen Tags enthalten.
|