Previous Next

Formatierung von Dokumentationsdateien

XML Tags

Jede Datei des Manuals muß 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änge

Die 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ückung

Eine 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.







    Zend_Magic existiert nicht. Zend_Acl existiert.

Zeilen Begrenzung

Die Zeilen Begrenzung 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 Tags

Leere Tags sind nicht erlaubt; alle Tags müssen Text oder Untertags enthalten.



    Irgendein Text. 



Verwendung von Leerzeichen in Dokumenten

Leerzeichen in Tags

Öffnende Block Tags sollten direkt nach Ihnen keine Leerzeichen haben sondern nur einen Zeilenumbruch (und Einrückungen in der folgenden Zeile).


LEERZEICHEN

Öffnende Inline Tags sollten keine Leerzeichen haben die Ihnen direkt folgen.


Das ist die Klasse  Zend_Class.


Das ist die Klasse Zend_Class.

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.


Das ist die Klasse Zend_Class 


Das ist die Klasse Zend_Class

Mehrere Zeilenumbrüche

Mehrere Zeilenumbrüche innerhalb oder auch zwischen Tags sind nicht erlaubt.



    Etwas Text...

    ... und mehr Text.




    Anderer Paragraph.




    Etwas Text...
    ... und mehr Text



    Anderer Paragraph.

Trennung zwischen Tags

Tags auf dem gleichen Level müssen durch eine leere Zeile getrennt sein um die Lesbarkeit zu erhöhen.



    Etwas Text...


    Mehr Text...




    Etwas Text...



    Mehr Text...

Das erste Untertag sollte direkt unterhalb seiner Eltern geöffnet werden, ohne das eine leere Zeile zwischen Ihnen ist; das letzte Untertag solte direkt vor dem Schließenden Tag seiner Eltern geschlossen werden.




    
    

    
    

    
    





    
    

    
    

    
    

Programm Auflistungen

Das öffnende <programlisting> Tag muss das richtige "language" Attribut anzeigen und auf dem gleichen Level eingerückt sein wie die vorhergehenden Blöcke.

Vorhergehender Paragraph.




            

CDATA sollte um alle Programm Auflistungen vorhanden sein.

<programlisting> Sektionen dürfen keine Zeilenumbrüche oder Leerzeichen am Anfang oder Ende der Sektion 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" Atribut mit einem Wert enthalten der dem Inhalt der Programm Auflistung entspricht. Typischerweise enthält es die Werte "css", "html", "ini", "javascript", "php", "text", und "xml".







            

Für Programm Auflistungen 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 Programm Auflistungen sollten den Coding Standard Empfehlungen folgen.

require_once(), require(), include_once() und include() sollten innerhalb von PHP Auflistungen 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.

Hinweis: Niemals Short Tags verwenden

Short Tags (z.B., "<?", "<?=") sollten niemals innerhalb von programlisting oder einer Dokuments verwendet werden.

Notizen zu speziellen Inline Tags

classname

Das 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.


    Die Klasse Zend_Class.

varname

Variablen müssen im <varname> Tag eingehüllt 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.


    Die Variable $var und die Klassenvariable
    Zend_Class::$var.

methodname

Methoden 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.


    Die Methode foo() und die Klassenmethode
    Zend_Class::foo(). Eine Methode mit der kompletten
    Signatur foo($bar, $baz)

constant

Das <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.


    Die Konstante FOO und die Klassenkonstante
    Zend_Class::FOO.

filename

Dateinamen und Pfade müssen im <filename> Tag enthalten sein. Kein anderer Inhalt ist innerhalb dieses Tags erlaubt.


    Die Datei application/Bootstrap.php.

command

Commands, Shell Skripte, und Programmaufrufe müssen im <command> Tag enthalten sein. Wenn das Kommando Argumente enthält sollten diese auch im Tag enthalten sein.


    Ausführen von zf.sh create project.

code

Die Verwendung des <code> Tags ist nicht erlaubt. Stattdessen sollten die anderen vorher besprochenen Inline Tags verwendet werden.

Notizen zu speziellen Block Tags

title

Das <title> Tag darf keine anderen Tags enthalten.


Verwendung von <classname>Zend_Class</classname>


Verwendung von Zend_Class
Previous Next
Einführung zum Zend Framework
Übersicht
Installation
Einstieg ins Zend Framework
Schnellstart in den Zend Framework
Zend Framework & MVC Einführung
Das Projekt erstellen
Ein Layout erstellen
Ein Modell und eine Datenbank Tabelle erstellen
Erstellen eines Formulars
Gratulation!
Autoloading im Zend Framework
Einführung
Ziele und Design
Grundsätzliche Verwendung von Autoloadern
Automatisches Laden von Ressourcen
Zusammenfassung
Plugins im Zend Framework
Einführung
Verwenden von Plugins
Fazit
Einstieg in Zend_Layout
Einführung
Zend_Layout verwenden
Zend_Layout: Fazit
Einstieg in Zend_View Platzhalter
Einführung
Grundsätzliche Verwendung von Platzhaltern
Standard Platzhalter
View Platzhalter: Fazit
Zend_Form's Gestalter (Decorator) verstehen und verwenden
Einführung
Decorator Grundlagen
Layeraufbau von Decorators
Darstellung individueller Decorators
Erstellung und Darstellung von kombinierten Elementen
Fazit
Einstieg in Zend_Session, Zend_Auth, und Zend_Acl
Erstellung von Multi-User Anwendungen mit Zend Framework
User Session im Zend Framework managen
Benutzer im Zend Framework authentifizieren
Erstellung eines Authorisations Systems in Zend Framework
Einstieg in Zend_Search_Lucene
Einführung in Zend_Search_Lucene
Lucene Index Struktur
Indezes öffnen und erstellen
Indizierung
Suchen
Unterstützte Abfragen
Seitendarstellung von Suchergebnissen
Einstieg in Zend_Paginator
Einführung
Einfaches Beispiel
Seitenkontrolle und ScrollingStyles
Alles zusammenfügen
Zend Framework's Referenz
Zend_Acl
Einführung
Verfeinern der Zugriffskontrolle
Fortgeschrittene Verwendung
Zend_Amf
Einführung
Zend_Amf_Server
Zend_Application
Einführung
Zend_Application Quick Start
Theorie der Funktionsweise
Beispiele
Kern Funktionalität
Vorhandene Ressource Plugins
Zend_Auth
Einführung
Datenbanktabellen Authentifizierung
Digest Authentication
HTTP Authentication Adapter
LDAP Authentifizierung
Open ID Authentifikation
Zend_Barcode
Einführung
Barcodes mit Hilfe der Zend_Barcode Klasse erstellen
Zend_Barcode Objekte
Zend_Barcode Renderer
Zend_Cache
Einführung
Die Theorie des Cachens
Zend_Cache Frontends
Zend_Cache Backends
Der Cache Manager
Zend_Captcha
Einführung
Captcha Anwendung
CAPTCHA Adapter
Zend_CodeGenerator
Einführung
Zend_CodeGenerator Beispiele
Zend_CodeGenerator Referenz
Zend_Config
Einleitung
Theory of Operation
Zend_Config_Ini
Zend_Config_Xml
Zend_Config_Writer
Zend_Config_Writer
Zend_Console_Getopt
Einführung
Definieren von Getopt Regeln
Holen von Optionen und Argumenten
Konfigurieren von Zend_Console_Getopt
Zend_Controller
Zend_Controller Schnellstart
Zend_Controller Grundlagen
Der Front Controller
Das Request Objekt
Der Standard Router
Der Dispatcher
Action Controller
Action Helfer
Das Response Objekt
Plugins
Eine konventionelle modulare Verzeichnis Struktur verwenden
MVC Ausnahmen
Zend_Currency
Einführung in Zend_Currency
Zend_Currency verwenden
Optionen für Währungen
Was macht eine Währung aus?
Wo ist die Währung?
Wie sieht die Währung aus?
Wie viel Währung habe ich?
Rechnen mit Währungen
Währungen wechseln
Zusätzliche Informationen für Zend_Currency
Zend_Date
Einführung
Theorie der Arbeitsweise
Basis Methoden
Zend_Date API Übersicht
Erstellen von Datumswerten
Konstanten für generelle Datums Funktionen
Funktionierende Beispiele
Zend_Db
Zend_Db_Adapter
Zend_Db_Statement
Zend_Db_Profiler
Zend_Db_Select
Zend_Db_Table
Zend_Db_Table_Row
Zend_Db_Table_Rowset
Zend_Db_Table Relationships
Zend_Db_Table_Definition
Zend_Debug
Variablen ausgeben
Zend_Dojo
Einführung
Zend_Dojo_Data: dojo.data Envelopes
Dojo View Helfer
Formular Elemente und Dekoratore für Dojo
Support für den Build Layer von Zend_Dojo
Zend_Dom
Einführung
Zend_Dom_Query
Zend_Exception
Verwenden von Ausnahmen
Grundsätzliche Verwendung
Vorherige Exceptions
Zend_Feed
Einführung
Feeds importieren
Feeds von Websites abrufen
Einen RSS Feed konsumieren
Einen Atom Feed konsumieren
Einen einzelnen Atom Eintrag konsumieren
Verändern der Feed- und Eintragsstruktur
Eigene Klassen für Feeds und Einträge
Zend_Feed_Reader
Zend_Feed_Writer
Zend_Feed_Pubsubhubbub
Zend_File
Zend_File_Transfer
Prüfungen für Zend_File_Transfer
Filter für Zend_File_Transfer
Zend_Filter
Einführung
Standard Filter Klassen
Filter Ketten
Filter schreiben
Zend_Filter_Input
Zend_Filter_Inflector
Zend_Form
Zend_Form
Schnellstart mit Zend_Form
Erstellen von Form Elementen mit Hilfe von Zend_Form_Element
Erstellen von Form durch Verwendung von Zend_Form
Erstellen von eigenem Form Markup durch Zend_Form_Decorator
Standard Form Elemente die mit dem Zend Framework ausgeliefert werden
Standard Formular Dekoratoren die mit dem Zend Framework ausgeliefert werden
Internationalisierung von Zend_Form
Fortgeschrittene Verwendung von Zend_Form
Zend_Gdata
Einführung
Authentifizierung mit AuthSub
Die Buchsuche Daten API verwenden
Authentifizieren mit ClientLogin
Google Kalender verwenden
Verwenden der Google Dokumente Listen Daten API
Verwenden von Google Health
Google Tabellenkalkulation verwenden
Google Apps Provisionierung verwenden
Google Base verwenden
Picasa Web Alben verwenden
Verwenden der YouTube Daten API
Gdata Ausnahmen auffangen
Zend_Http
Einführung
Zend_Http_Client - Fortgeschrittende Nutzung
Zend_Http_Client - Verbindungsadapter
Zend_Http_Cookie und Zend_Http_CookieJar
Zend_Http_Response
Zend_InfoCard
Einführung
Zend_Json
Einführung
Grundlegende Verwendung
Fortgeschrittene Verwendung von Zend_Json
XML zu JSON Konvertierung
Zend_Json_Server - JSON-RPC Server
Zend_Layout
Einführung
Zend_Layout Schnellstart
Zend_Layout Konfigurations Optionen
Erweiterte Verwendung von Zend_Layout
Zend_Ldap
Einführung
API Übersicht
Szenarien der Verwendung
Tools
Objektorientierter Zugriff auf den LDAP Baum durch Verwendung von Zend_Ldap_Node
Informationen vom LDAP Server erhalten
Serialisieren von LDAP Daten von und zu LDIF
Zend_Loader
Dynamisches Laden von Dateien und Klassen
Der Autoloader
Ressource Autoloader
Plugins laden
Zend_Locale
Einführung
Zend_Locale verwenden
Normalisierung und Lokalisierung
Arbeiten mit Daten und Zeiten
Unterstützte Gebietsschemata
Zend_Log
Übersicht
Writer
Formatter
Filter
Die Factory verwenden um ein Log zu erstellen
Zend_Mail
Einführung
Versand über SMTP
Versand von mehreren E-Mails über eine SMTP Verbindung
Verwendung von unterschiedlichen Versandwegen
HTML E-Mail
Anhänge
Empfänger hinzufügen
Die MIME Abgrenzung kontrollieren
Zusätzliche Kopfzeilen
Zeichensätze
Kodierung
SMTP Authentifizierung
SMTP Übertragungen sichern
Lesen von Mail Nachrichten
Zend_Markup
Einführung
Beginnen mit Zend_Markup
Zend_Markup Parser
Zend_Markup Renderer
Zend_Measure
Einführung
Erstellung einer Maßeinheit
Ausgabe von Maßeinheiten
Manipulation von Maßeinheiten
Arten von Maßeinheiten
Zend_Memory
Übersicht
Memory Manager
Memory Objekte
Zend_Mime
Zend_Mime
Zend_Mime_Message
Zend_Mime_Part
Zend_Navigation
Einführung
Seiten
Container
Zend_Oauth
Einführung zu OAuth
Zend_OpenId
Einführung
Zend_OpenId_Consumer Grundlagen
Zend_OpenId_Provider
Zend_Paginator
Einführung
Verwendung
Konfiguration
Advanced usage
Zend_Pdf
Einführung
Erstellen und Laden von PDF Dokumenten
Änderungen an PDF Dokumenten speichern
Arbeiten mit Seiten
Zeichnen
Interaktive Features
Dokument Informationen und Metadaten
Anwendungsbeispiel für die Zend_Pdf Komponente
Zend_ProgressBar
Zend_ProgressBar
Zend_Queue
Einführung
Beispiel der Verwendung
Framework
Adapter
Anpassen von Zend_Queue
Stomp
Zend_Reflection
Einführung
Zend_Reflection Beispiele
Zend_Reflection Referenz
Zend_Registry
Die Registry verwenden
Zend_Rest
Einführung
Zend_Rest_Client
Zend_Rest_Server
Zend_Search_Lucene
Überblick
Indexerstellung
Einen Index durchsuchen
Abfragesprache
Abfrage Erzeugungs API
Zeichensätze
Erweiterbarkeit
Zusammenarbeit Mit Java Lucene
Erweitert
Die besten Anwendungen
Zend_Serializer
Einführung
Zend_Serializer_Adapter
Zend_Server
Einführung
Zend_Server_Reflection
Zend_Service
Einführung
Zend_Service_Akismet
Zend_Service_Amazon
Zend_Service_Amazon_Ec2
Zend_Service_Amazon_Ec2: Instanzen
Zend_Service_Amazon_Ec2: Windows Instanzen
Zend_Service_Amazon_Ec2: Reservierte Instanzen
Zend_Service_Amazon_Ec2: CloudWatch Monitoring
Zend_Service_Amazon_Ec2: Amazon Maschinen Images (AMI)
Zend_Service_Amazon_Ec2: Elastischer Block Speicher (EBS)
Zend_Service_Amazon_Ec2: Elastische IP Adressen
Zend_Service_Amazon_Ec2: Schlüsselpaare
Zend_Service_Amazon_Ec2: Regionen und Availability Zones
Zend_Service_Amazon_Ec2: Sicherheitsgruppen
Zend_Service_Amazon_S3
Zend_Service_Amazon_Sqs
Zend_Service_Audioscrobbler
Zend_Service_Delicious
Zend_Service_DeveloperGarden
Zend_Service_Flickr
Zend_Service_LiveDocx
Zend_Service_Nirvanix
Zend_Service_ReCaptcha
Zend_Service_Simpy
Zend_Service_SlideShare
Zend_Service_StrikeIron
Zend_Service_StrikeIron: Mitgelieferte Services
Zend_Service_StrikeIron: Erweiterte Verwendung
Zend_Service_Technorati
Zend_Service_Twitter
Zend_Service_WindowsAzure
Zend_Service_Yahoo
Zend_Session
Einführung
Grundsätzliche Verwendung
Fortgeschrittene Benutzung
Globales Session Management
Zend_Session_SaveHandler_DbTable
Zend_Soap
Zend_Soap_Server
Zend_Soap_Client
WSDL Zugriffsmethoden
AutoDiscovery
Zend_Tag
Einführung
Zend_Tag_Cloud
Zend_Test
Einführung
Zend_Test_PHPUnit
Zend_Test_PHPUnit_Db
Zend_Text
Zend_Text_Figlet
Zend_Text_Table
Zend_TimeSync
Einführung
Arbeiten mit Zend_TimeSync
Zend_Tool
Verwendung von Zend_Tool auf der Kommandozeile
Zend_Tool erweitern
Zend_Tool_Framework
Einführung
Verwenden des CLI Tools
Architektur
Erstellen von Providern für die Verwendung mit Zend_Tool_Framework
Mitgelieferte System Provider
Extending and Configuring Zend_Tool_Framework
Zend_Tool_Project
Einführung
Ein Projekt erstellen
Project Provider für Zend_Tool
Zend_Tool_Project Internas
Zend_Translate
Einführung
Adapter für Zend_Translate
Verwendung der Übersetzungsadapter
Erstellen von Quelldateien
Zusätzliche Features für Übersetzungen
Schreibweisen von Pluralformen für Übersetzungen
Zend_Uri
Zend_Uri
Zend_Validate
Einführung
Standard Prüfklassen
Kettenprüfungen
Schreiben von Prüfern
Prüfungsmeldungen
Zend_Version
Die Version des Zend Frameworks erhalten
Zend_View
Einführung
Controller Skripte
View Scripte
View Helfer
Zend_View_Abstract
Zend_Wildfire
Zend_Wildfire
Zend_XmlRpc
Einführung
Zend_XmlRpc_Client
Zend_XmlRpc_Server
ZendX_Console_Process_Unix
ZendX_Console_Process_Unix
ZendX_JQuery
Introduction
ZendX_JQuery View Helpers
ZendX_JQuery Form Elements and Decorators
Zend Framework Voraussetzungen
Einführung
Zend Framework's Migrationshinweise
Zend Framework 1.10
Zend Framework 1.9
Zend Framework 1.8
Zend Framework 1.7
Zend Framework 1.6
Zend Framework 1.5
Zend Framework 1.0
Zend Framework 0.9
Zend Framework 0.8
Zend Framework 0.6
Zend Framework Coding Standard für PHP
Übersicht
PHP Dateiformatierung
Namens Konventionen
Code Stil
Zend Framework Dokumentations Standard
Übersicht
Formatierung von Dokumentationsdateien
Empfehlungen
Vorgeschlagene Struktur für die Projekt Struktur von Zend Framework MVC Anwendungen
Übersicht
Vorgeschlagene Verzeichnis Struktur für Projekte
Modul Struktur
Leitfaden für die Rewrite Konfiguration
Zend Framework's Performanceratgeber
Einführung
Laden von Klassen
Zend_Db Performance
Internationalisierung (I18n) und Lokalisierung (L10n)
Darstellen der View
Urheberrecht Informationen