Programmspezifische Elemente

(Auszug aus "DocBook-XML: Medienneutrales und plattformunabhängiges Publizieren" von Thomas Schraitle)

Zu dieser Kategorie zählen die folgenden Elemente (die Kategorien sind nicht willkürlich, sondern stammen aus dem DocBook-RELAX NG-Schema) :

classname, exceptionname, interfacename, methodname

Diese Elemente werden eingesetzt, um objektorientierte Programme, Sprachen oder Architekturen zu dokumentieren:

<para>Die Klassenbibliothek QT besitzt die Klasse <classname>QSvgWidget</classname> mit der Methode <methodname>load</methodname>. XML-Exceptions werden durch <exceptionname>QXmlParseException</exceptionname> behandelt.</para>

function, parameter, returnvalue

Zum Beschreiben von Funktionen, Parametern und Rückgabewerten:

<para>Python erwartet in der Funktion <function>lexists</function> den Parameter <parameter>path</parameter> und gibt als Rückgabewert <returnvalue>True</returnvalue> oder <returnvalue>False</returnvalue> zurück.</para>

varname

Der Name einer Variablen:

<para>In Python enthält <varname>sys.argv</varname> die Kommandozeilenparameter beim Aufruf des Skripts.</para>
Tipp der data2type-Redaktion:
Zum Thema DocBook bieten wir auch folgende Schulungen zur Vertiefung und professionellen Fortbildung an:

Copyright © 2009 Millin Verlag
Für Ihren privaten Gebrauch dürfen Sie die Online-Version ausdrucken.
Ansonsten unterliegt dieses Kapitel aus dem Buch "DocBook-XML: Medienneutrales und plattformunabhängiges Publizieren" denselben Bestimmungen, wie die gebundene Ausgabe: Das Werk einschließlich aller seiner Teile ist urheberrechtlich geschützt. Alle Rechte vorbehalten einschließlich der Vervielfältigung, Übersetzung, Mikroverfilmung sowie Einspeicherung und Verarbeitung in elektronischen Systemen.

Millin Verlag, Siebengebirgsring 36, 53797 Lohmar, info(at)millin.de