Beispiele
Die Beispiele auf dieser Seite zeigen dieselbe Dokumentation basierende auf unterschiedlichen Vorlagen. In der Installation von Doc-O-Matic sind vorgefertigte Vorlagen für Hilfe im Stil von Visual Studio 2010, Visual Studio 2008, Visual Studio 2005, Embarcadero RAD Studio XE, Embarcadero RAD Studio 2010, CodeGear Delphi 2007, Visual Studio 2003 und anderen enthalten. Die Standardvorlagen schliessen Konfigurationen für Hilfeintegration, eine Web-Hilfe-Konfiguration für das Onlinestellen im selben Stil sowie eine Druckkonfiguration für PDF ein.
Das erste Bildschirmfoto zeigt den neuen Visual Studio 2010 Hilfe-Stil wie mit der Visual Studio 2010 Projektvorlage erzeugt in einem Help 3 Kontext. Sie integriert sich visuell in die MSDN Bibliotheksdokumentation und schliesst Funktionen wie Register-Abschnitte, mehrsprachige Syntax und automatisches Verknüpfen innerhalb des Projekts und in die MSDN-Hilfe ein.
Das mittlere Bildschirmfoto zeigt den selben Inhalt im Stil der Visual Studio 2008 Integration angezeigt in einem Help 2 Browser. Dieser Stil schliesst aufklappbare Abschnitte und automatische Anker für "Siehe auch"-Abschnitte und "Nach oben"-Verknüpfungen ein. Hilfe-Leser können mit der Verknüpfung "Alles Zusammenklappen/Alles erweitern" im Kopfbereich alle zusammenklappbaren Abschnitte auf einmal ändern. Der Status der Abschnitte wird über die Sitzungen hinweg gespeichert.
Das letzte Bildschirmfoto zeigt die Visual Studio 2005 Vorlage, wieder mit dem selben Inhalt.
Quellcode
Doc-O-Matic versteht wie Entwickler den Quellcode dokumentiert. Der folgende Quellcode Kommentar ist Dank der Fähigkeit von Doc-O-Matic natürlichsprachliche Kommentare zu verstehen, leicht lesbar.
Wenn Sie XML Doc oder JavaDoc bevorzugen, Doc-O-Matic unterstützt beide gleich gut und alle drei Formate sind auch im Editor unterstützt, der Kommentare in den Quellcode zurückschreibt.
// Description:
// Use the find function to locate a string S in the string list.
// Only use this function if the string list is sorted, to locate
// a string in a non-sorted string list use IndexOf.
// See Also:
// IndexOf, Sort, Sorted
// Arguments:
// S - The string to be located.
// Index - The index of S is returned through this parameter if it
// was found. It is not guaranteed that Index is not
// modified, even if the string isn't found.
// Return Value:
// TRUE if the string could be found in the string list,
// FALSE otherwise.
// Summary:
// Locates a string in the string list.
bool Stringlist::Find(const char *S, int &Index) { [...] }















