Features

Doc-O-Matic ist ein mächtiges Werkzeug mit grosser Flexibilität. Dieser Abschnitt soll Ihnen die verschiedenen Features von Doc-O-Matic näher bringen und erläutern, wie diese Ihnen helfen können, Ihr Dokumentationsproblem zu lösen.

Zusammenfassung

Softwareentwicklung wird immer komplexer, daher ist ein verlässliches Programm, das die Anfertigung einer Dokumentation erleichtert und diese immer am aktuellen Stand hält, unentbehrlich. Softwareentwickler, die um ein gutes Produkt bemüht sind, brauchen eine Online Hilfe und druckbare Dokumente sowohl für die Benutzer der Software als auch für das Entwicklerteam.

Diese Arbeit kann erleichtert werden, wenn man ein Programm verwendet, das die Dokumentation in vielen leicht zugänglichen Formaten von nur einer Textquelle erzeugt.

Doc-O-Matic Facts

Die Verwendung von Doc-O-Matic hat folgende Vorteile:

  • Die Dokumentation ist immer aktuell und am neusten Stand.
  • Doc-O-Matic unterstützt viele der meistverwendesten Programmiersprachen.
  • Doc-O-Matic passt sich Ihrer Art Quellcode zu dokumentieren an und unterstützt XML Doc und JavaDoc.
  • Mit Doc-O-Matic kann man sowohl Quellcodedokumentation als auch Anwenderhilfe verfassen.
  • Doc-O-Matic erzeugt leicht zugängliche Ausgabeformate, die an die jeweiligen Bedürfnisse angepasst werden können.
  • Doc-O-Matic stellt Ihnen Vorlagen zur Verfügung mit deren Hilfe Sie Hilfe im Stil von Visual Studio und MSDN Hilfe und Delphi VCL Hilfe erstellen können.
  • Doc-O-Matic unterstützt Sie bei der Verwaltung Ihres Quellcodes mit einem Werkzeug zur graphischen Darstellung von Klassenhierarchien einem flexiblen Werkzeug zur Erstellung von Berichten und einem graphischen Tool zur Qualitätssicherung der Dokumentation.
  • Doc-O-Matic erzeugt Quellcodedokumentation und Anwenderhilfe in Browser basiertem HTML, HTML Help, Help 2, Help Viewer, PDF, RTF und XML.
  • Doc-O-Matic ist ein Tool das aus einer Quelle verschiedene Ausgaben erzeugt.
  • Doc-O-Matic ist ein selbständiges Windows Programm mit einem benutzerfreundlichen Oberfläche.
  • Doc-O-Matic stellt einen Kommandozeilenkompiler zur Verfügung, womit Doc-O-Matic leicht in einen automatische Erzeugungsprozess integriert werden kann.

Doc-O-Matic wird in allen Arten von Industrien eingesetzt, von Halbleiterherstellern bis zu Spieleentwicklungsfirmen. Lesen Sie mehr in der Sektion Was Kunden sagen.

Feature-Übersicht

Allgemeine Funktionen

  • Eingebaute Unterstützung für C/C++, C#, Delphi, VB.NET, IDL, Java, ASPX, JSP, JavaScript, Matlab und PHP
  • Integrierte Unterstützung für Macro-Auflösung, Bedingte Definitionen, Überspringen von Code und mehr
  • Verwendet die Benutzungsinformationen von Namesräumen für die Auflösung von Symbolreferenzen und automatisches Verknüpfen
  • Vollständige Sprachunterstützung, eine Konfiguration notwendig
  • Module und getrennte Hierarchien für Module
  • Member Ordner für Namensräume und Module
  • Erweiterte Methodenordner, Sichtbarkeitsordner
  • Memberübersichtsseiten
  • Unterstützt Unicode-Dateien und Unicode-Kennzeichner

Verwalten von Code und Dokumentation

  • Visueller Inhaltsmanager und Inhaltsverzeichnisdesigner
  • Projektmanager für Quelldateien, Bilder- und Include-Pfade, Module und Ausgabedateien
  • Projektweite Suche
  • Projektstatistik einschliesslich Wortzählung
  • Klassenhierarchie-Visualisierung und Design-Werkzeug
  • Berichte
  • QA Manager zum visualisieren des Dokumentationsstatus von Projekten
  • Qualitätssicherungsfunktionen um sicherzustellen, dass die Dokumentation auf dem neuesten Stand und vollständig ist
  • Master-Projekte, Fähigkeit die Inhaltsinformationen in externen Dateien zu speichern

Kommentare extrahieren

  • Extrahiert existierende ungetagte Beschreibungen aus Kommentaren, Formatierung ohne Tags für Abschnitte, Listen Überschriften und Tabellen
  • Unterstützt einfache HTML Formatierungen in Kommentaren
  • Extrahiert Kommentare aus allen Quelldateien, die Kommentare unterstützen (zum Beispiel Assembler, VB6, SQL, Perl, LISP, Ada, Fortran, COBOL)
  • Optionale exklusive Verwendung von Dreifach-Slash-Kommentaren (C/C++, C#, Delphi) und Dreifach-Anführungszeichen-Kommentaren (VB.NET)

Handbücher-Schreiben und Editieren

  • "Single source" Hilfetool, erzeugt aus einer Quelle mehrere Ausgabeformate
  • Schreiben von bedingtem Text auf Buchstaben-, Abschnitts- und Themenebene
  • Visueller Inhaltsverzeichnisdesigner
  • Text-Wiederverwendungsfunktionen wie Schnipsel und Textvariablen
  • Labels um bestimmte Textteile zu kennzeichnen und automatisch bei der Ausgabe zu formatieren (benutzbar z.b. für Menüpfade, eingebettete Abschnitte und vieles mehr)
  • Integrierter Themeneditor mit einer gewohnten Benutzerschnittstelle
  • Vollständige Trennung von Hilfeschreiben und Ausgabedesign

Quellcode Beschreiben

  • Voll ausgestatteter Editor
  • QuickDoc Arbeitsablaufsmanagement
  • Live Rechtschreibkorrektur
  • Einfügen von Tabellen, Bildern, Verknüpfungen (innerhalb der Dokumentation und externe Verweise zu URLs und Dateien) Flags, Schlagworte, Farben, Titel, Buchstaben- und Absatzformatierung
  • Fügt Klartext-formatierte Kommentare und Quellcode oder externe Dokumentationsdateien ein
  • Benutzt Projektdatenbanken um einfach in andere Projekte und IDE-Hilfesysteme zu verweisen (MFC, VCL und .NET)
  • Vordefinierte aber anpassbare Dokumentationsabschnitte, die es ermöglichen einfach Zusammenfassungen, 'Siehe auch' Verweise, Beispiele, Parameterbeschreibungen, Rückgabewerte und Beispiel-Code zu erzeugen
  • Beschreiben Sie Code an verschiedenen Orten
  • Filter für Symbole
  • Quellcode-Ansicht die optional gesamte Dateien anzeigt
  • Importiert HTML-Dateien, Klartextdateien und Word-Dokumente

Werkzeuge

  • Kommandozeilen-Compiler
  • Werkzeuge um die Entwicklung im Team und das Zusammenfügen von Projekten zu unterstützen (Editorvorlagen, Projektimport und Projektvorlagen)
  • Werkzeug um Quellcodekommentare in externe Dateien zu verschieben
  • Code-Übersetzungs-Werkzeug um die Syntax-Übersetzungs-Matrix zu warten
  • HxBrowse um die Help 2 Namensraumregistry zu anzusehen
  • tfhxreg um Help 2 Dateien zu mit voller Unicode-Unterstützung zu registrieren

Allgemeine Ausgabeformatfunktionen

  • Hinzufügen von mehreren Konfigurationen für jedes Ausgabeformat
  • Benutzung von vorformatierten Vorlagen oder Verwendung von eigener Formatierung der Ausgabe
  • Erzeugt vollverknüpfte graphische Klassenhierarchien und Diagramme (einschliesslich abgeleiteter Klassen)
  • Vollständig anpassbare Symbolübersichten und Navigationsseiten. Optional einschliesslich Basisklassen-Members
  • Generiert Inhalt für Ordner und Member-Übersichtsseiten
  • Erzeugt Syntax-Abschnitte mit mehreren Programmiersprachen
  • Stellt vollautomatisches Erzeugen von Verknüpfungen innerhalb des Projekts, zwischen verschiedenen Projekten und zwischen Projekten und MFC, VCL und .NET Framework Hilfe zur Verfügung
  • Automatisches Erzeugen von verknüpften Berichten (z.b. "alle zu erledigen"-Abschnitte, "alle Fehler"-Abschnitte, alle veralteten Symbole und ein Glossar)
  • Fügt zusätzlichen Gruppierungsebenen für Symbole ein, die automatisch in Übersichtsseiten integriert werden
  • Anpassbare Ausgabeformatierung mit Inhaltsverzeichnis, Index, Kopf- und Fußzeilen für jedes Ausgabeformat
  • Stellt Übersetzungen für alle vordefinierten Worte in der Ausgabe zur Verfügung
  • Bedingter Text

PDF

  • Erzeugt PDF-Dateien und Handbücher ohne zusätzliche Werkzeuge
  • Inhaltsverzeichnis, Index, Titelseite und Impressum
  • Verweise mit Seitenangabe für zum Drucken bestimmte Handbücher
  • Verweise zu anderen PDF Dokumenten und zu URLs
  • Anpassbare Seiten- und Überschriftennummerierung in PDF
  • Doppelseitendruck
  • Kapitel-Register
  • Flexible Kopf- und Fußzeilenkonfiguration mit variablen-gesteuerten Werten für Thementitel, Nummerierung, Seitennummern und Seitenanzahl

HTML Hilfesysteme

  • Verwenden von Vorlagen für Visual Studio und Embarcadero Hilfestyles.
  • Unterstützung für Kontextsensitive Hilfe für C++ und Delphi
  • Stellt Projektdatenbanken für das Verknüpfen in Visual Studio Framework Hilfe, VCL Hilfe und MSDN zur Verfügung
  • Unterstützung für Visual Studio Dynamic Help
  • Zeigt optional alle Unterthemen auf einer Seite an (z.B. alle Members einer Klasse oder alle Variablen)
  • Voll anpassbare Willkommensseite, Möglichkeit zusätzliche Dateien zum Projekt hinzuzufügen
  • Unterstüzung für normales HTML, HTML Help, Help 2 und Help Viewer
  • Rahmen
  • Zusätzlicher CSS-Code fûr all Formatierungselement
  • Aufklappbare Abschnitte
  • Register-Abschnitte
  • Automatische Ankergenerierung für alle Abschnitte und "Nach oben"-Verknüpfungen
  • Popup-Unterstützung
  • Einbinden von vorformatierten HTML Dateien
  • Fixierter Kopfbereich
  • Verknüpfte Bilder, automatische "große Bilder" und Bilder mit "hover" Effekt
  • Dynamische Inhaltsseite mit automatischer Synchronisation mit dem ausgewählten Thema
  • HTML 5, XHTML 1 oder HTML 4.01 konforme Ausgabe

XML Ausgabe

  • Anpassbare Abschnitts-Tags
  • Symbolstruktur

Übersetzung

  • Das Übersetzen der Ausgabe wird in Doc-O-Matic Projekten an einer zentralen Stelle gesteuert, dem Übersetzungs-Wörterbuch. Alle Textteile im Projekt, die möglicherweise übersetzbaren Inhalt enthalten, werden bei der Ausgabe mit dem Wörterbuch übersetzt. Doc-O-Matic wird mit übersetzten Bildern für Buttons für HTML-Ausgabe geliefert und es gibt ein Werkzeug zum einfachen Umschalten der Sprache.

Feature-Matrix

  Professional Author*
Platformen
Unterstützt Windows 32-bit
Unterstützt Windows 64-bit
Programmiersprachen und Eingabeverarbeitung
Sprachgruppe I: C/C++, C++/CLI, C#, Delphi, VB.NET n/a
Sprachgruppe II: IDL, ASP.NET, Java, JavaScript, JSP, MATLAB, PHP n/a
Unterstützung für Quellcodekommentare n/a
Unterstützung für XML Dokumentationsdateien
Unterstützung für externe Dokumentation n/a
Unterstützt Dateien und Bezeichner in Unicode
Unterstützung für externe Unicode-Dokumentation
Master Projekte und externe TOC Dateien
Übersetzungsverzeichnis für Ausgabe in anderen Sprachen
Anpassbare Quellcode Parser Konfiguration n/a
Erweiterte C++ Parser Funktionen (System Includes, prototyplose Funktionen, Setter/Getter Konvertierung, Macro Expandierung) n/a
Namesbereich-Layout Konfiguration n/a
Erweiterte Pascal Parser Funktionen (Implementation Sektion Parsen, System auto-using) n/a
Unterstützung für bedingte Definitionen n/a
Code Skipping n/a
Grundlegende Kommentarfindungskonfiguration (Kommentartoken, Kommentarposition, Listen, Mauern, etc) n/a
Erweiterte Kommentarverarbeitung (Dreifachslash Kommentare, Parameterlistenbeschreibung, Ignorierte Zeilen, Kommentarausschlusstokens) n/a
Konfiguration von Themenverarbeitungsoptionen (Leere Themen, Auto-Combine Überladungen, Vererbte Dokumentation, Multi-Position Konfiguration) n/a
Automatischer Text Einstellungen (automatische Snippets, automatischer Text für undokumentierte Symbole)
Unterstützung für XML Doc, JavaDoc und natürliche Kommentare n/a
Grundlegende Abschnittskonfiguration (Typänderung und Starterstringänderung)
Erweiterte Abschnittskonfiguration (hinzufügen, löschen, Starter-Delimiter-Konfiguration, Leerzeichenverarbeitung)
Integrierte Editorkonfiguration
Farbeinrichtung
Managementfunktionen
Content Designer für Inhaltsverzeichnisdesign und individuelle Themenselektion
Visuelle Kontrolle über Exportstatus für individuelle Themen
Projektmanager
Symbol- und Themenfilterung
Projekt-Import-Werkzeug für Teamentwicklung
QuickDoc
Dokumentation-Verschiebungs-Werkzeug
Berichtemanager
Qualitätssicherungsmanager n/a
Klassenhierarchieanzeige n/a
Codeübersetzungsmatrixeditor n/a
Einfaches Projektkonfigurationstool    
Editor und Hilfeschreiben
Vollständig visueller WYSIWYG Editor
Standard Textverarbeitungsfunktionen einschliesslich fett, kursiv, unterstrichen, nichtproportional, tiefgestellt und hochgestellt
Farbkonfiguration mit Farbnamen
Listen, Tabellen, Bilder, geprüfte Links, Codeblöcke, Überschriften, Absatzausrichtung
Schnelle Themenerzeugung und Navigation
Einfaches Bildmanagement
Schnelle Editorfunktionen wie "Link folgen"
Bedingter Text mit Abschnitten
Snippets
Text Variablen
Live Rechtschreibüberprüfung und projektweite Rechtschreibüberprüfung
Automatisches Formatieren von Text Variablen
Text Labels
Bedingter Text mit Text Labels
Automatische Formatierung, Ersetzung und Textauszeichnung mit Text Labels
Generelle Ausgabefunktionen
Automatisch generierte Navigationstabellen
Automatisch generierte Navigationseiten
Vollautomatisches Verknüpfen innerhalb von Projekten und zu externen Projekten
Automatisch generierte Symbolübersichten n/a
Berichte
Glossar
Lokale Klassenhierarchien n/a
Klassenhierarchie für das Projekt n/a
Klassenhierarchie für alle Module n/a
Visueller Inhaltsverzeichnisdesigner
Module für die Unterteilung von Projekten n/a
Projektdatenbanken für Verknüpfungen zwischen Projekten
Automatisches Verknüpfen und Verknüpfungspseudonyme
Automatisches Einfügen von Snippets in alle Themen
AutoDoc Funktionen
Automatische Exportmengenselektion basierend auf Symboltypen (Klasse, Typ, Funktion, ...) n/a
Automatische Exportmengenselektion basierend auf Elementsichtbarkeit (public, protected, private) n/a
Automatische Exportmengenselektion basierend auf Dokumentationstatus n/a
Erweiterte Exportmengenselektion (Themen Status, Themenversionsinformation) n/a
AutoDoc Ordnerkonfiguration n/a
AutoDoc Seitentextkonfiguration n/a
Konfiguration der Navigationsbeschreibung
Beschränkung der Navigationsbeschreibungslänge
Konfiguration des Navigationstabellenlayoutes
Erweiterte Elementtabellenkonfiguration (vererbte Elemente, Subkategorien, Sichtbarkeitstypenkombination, Überladungen) n/a
Erweiterte Dateiabschnittskonfiguration n/a
Konfiguration der Indikatorbilder
Konfiguration der Vorgabetitel (Seitentitel, Inhaltstitel, Indextitel) n/a
AutoDoc Titelkonfiguration n/a
Automatische Indexgenerierung
Erweiterte Indexkonfiguration
Indexvorsilbenentfernung
Erweiterte Optionen für Navigationsabschnitte und Zusatzinformationsabschnitte (Benennung, Deklarationstext, Tabellenlayout)
Automatisches Erzeugen der Zusammenfassung
Automatische Generierung des Deklarationssourcecodes n/a
Konfiguration von Optionen für Deklarationsquellcode und Syntaxhervorhebung n/a
Multi-Sprach-Syntaxausgabe n/a
Funktionsrumpfausgabe n/a
Rumpfausgabe für Dateien n/a
Lokale graphische Klassenhierarchien n/a
Textklassenhierarchien n/a
Konfiguration für Layout und Design der graphischen Klassenhierarchien n/a
Projektdatenbanken für automatisches Verknüpfen zwischen Doc-O-Matic Projekten
Automatisches Verknüpfen
Erweiterte Auto-Linkeroptionen (minimale Wortlänge, verbotene Wörter)
Automatische Verknüpfungspseudonyme
Themen Flags
Automatische Qualitätssicherungsprüfungen (Dokumentations Status, Parameterbeschreibung, Parameternamen, Rückgabewertbeschreibung) n/a
Spezielle Ausgabeerzeugungsschritte
HTML, HTML Hilfe, Help 2, Help Viewer, Web Help
Grundlegende Datei- und Verzeichnisoptionen (Ausgabepfad, Dateinamen)
HTML 5, XHTML und HTML 4.01 konforme Ausgabe
Zusätzliche HTML-Ausgabe Dateioptionen (spezielle Dateibenennung, Vorlagedateien, zusätzliche Dateien, spezielle Willkommen-Seite)
Section Reihenfolge und Überschriftenkonfiguration
Erweiterte Abschnittsausgabeoptionen (automatische Tabellenkonfiguration, Navigationslinks und Sectionkonfiguration)
Zusammenklappbare Sections
Register-Abschnitte
Volle Kontrolle über das Layout und die Formatierung
Seiten Kopf- und Fusszeilenkonfiguration
Themen Pfade
Eingebettetes Inhaltsverzeichns und Index für Sofortzugriff
Dynamische Themenpfade
Erweiterte Ausgabeoptionen (Willkommen-Seite, Inhaltsverzeichnis, Index, Copy Links, ...)
Dynamisch expandierendes Inhaltsverzeichnis
Spezielle Headerinformation
HTML-Seiten Kodierung
Grosse Bilder und Hoverglanzlicht-Bilder
Spezielle Suchseitenintegration
HTML Dateivorlage zur einfachen Integration in bestehende Layouts
PDF
Anpassbare PDF Ausgabe
Doppelseitiger Druck
Wasserzeichen
Hyperlinks innerhalb und ausserhalb des Dokuments
Section Reichenfolge und Überschriftenkonfiguration
Erweiterte Abschnittsausgabeoptionen (automatische Tabellenkonfiguration, Navigationsverknüpfungen und Abschnittskonfiguration)
Volle Kontrolle über das Layout und die Formatierung
Seiten Kopf- und Fußzeilenkonfiguration
Volle Kontrolle über automatische Seitennummerierung und Themennummerierung
Erweiterte PDF Funktionen (Lesezeichen, Titelseite, Copyright Seite, Inhaltsverzeichnis, Nummerierung, Index, Kapitelregister)
Graphik für die Titelseite
Thementitelkonfiguration
Erweiterte Ausgabeoptionen (Bildauflösung, Ausgabebilder, Flag-Anzeige)
RTF
Anpassbare RTF Ausgabe
Doppelseitiger Druck
Hyperlinks innerhalb und ausserhalb des Dokuments
Section Reichenfolge und Überschriftenkonfiguration
Erweiterte Abschnittsausgabeoptionen (automatische Tabellenkonfiguration, Navigationsverknüpfungen und Abschnittskonfiguration)
Volle Kontrolle über das Layout und die Formatierung
Seiten Kopf- und Fußzeilenkonfiguration
Volle Kontrolle über automatische Seitennummerierung und Themennummerierung
Erweiterte RTF Funktionen (Titelseite, Copyright Seite, Inhaltsverzeichnis, Nummerierung, Index)
XML
Grundlegende Datei- und Verzeichnisoptionen (Ausgabepfad, Dateinamen)
Kodierung
Strukturoptionen
Tagoptionen
(*) Als reines Hilfe-Authoring-Tool hat Doc-O-Matic Author keine Quellcode-Dokumentationsfunktionen. Diese Funktionen sind in der Tabelle mit n/a gekennzeichnet.

Was Benutzer sagen

Building the API documentation with Sandcastle took about 30 minutes on my virtual machine. Building the same documentation with Doc-O-Matic on the same machine took 3 minutes.
Jesper Högström, CapableObjects
Doc-O-Matic was an essential component of Delphi 2007's tremendously improved help system experience. Markus and his team were instrumental in making our documentation content more useful and accessible and Doc-O-Matic made building our help content fast and easy.
Nick Hodges, Delphi Program Manager - CodeGear
Doc-O-Matic has made the tedious process of generating help documentation for our product lines a breeze. It has literally saved us hundreds of hours when generating our online help I don't know what we would do without it.
Kirk Stowell, President and CEO - codejocksoftware
Game development becomes increasingly harder as the size of the projects and the required content grows bigger. One area we've been improving internally is our software documentation for our core libraries. After reviewing other freeware and commercial documentation programs, we decided to use Doc-O-Matic because of the great job it does extracting documentation from our code, the ability to switch between many different output formats, and the professional looking documentation that it produces. The amount of options available in Doc-O-Matic makes it easy to customize our documentation to fit our needs.
Michael Kelley - Rockstar San Diego
Doc-O-Matic is a superb, well-supported product - and it has steadily improved with each release. We've used the product since version two and toolsfactory has been openly receptive to feature requests and very responsive and tech-support inquiries. Some of our C++ libraries contain hundreds of source files and classes - but Doc-O-Matic handles them with aplomb. Doc-O-Matic is indispensable.
Jim Henderson, President - Innovative Integration
This tool is absolutely fantastic! There's no doubt in my mind that Doc-O-Matic is the best documentation tool on the planet. I should know, because I've probably used just about all of them. Doc-O-Matic's model is far superior to most models for help authoring (such as that of RoboHelp) which require a lot of labor-intensive manual work that has nothing to do with content development. And compared to the help tools with similar code parsing models (NDoc, Doxygen, etc.), Doc-O-Matic is absolutely matchless in features and flexibility.
Bruce Denham - Schlumberger
Doc-O-Matic continues to prove invaluable in our documentation process. It allows us to document our work in a natural and readable fashion, and the graphical interface lets us stay completely in control of the whole process. The level of customer support is also excellent. I have no hesitation in recommending this software to anyone who is thinking about in-line documentation for their code.
Jason G Doig, Principal Engineer - Sony Computer Entertainment Europe R&D
We used Doc-O-Matic to produce documentation for a brand new code base and had great results. We documented approximately 1000 API functions and data types for a new project. Without Doc-O-Matic there is no way we would have been able to produce such a nice and complete set of documentation for our customers and have it ready immediately. Before Doc-O-Matic we produced documentation manually, and not only did it take a long time, but the documentation was often out of date just because it was so tedious to make updates. I have looked over the past several years for a decent way to automate our documentation, and evaluated several other products, but Doc-O-Matic is the first product I found that I consider to be really useable, and fully customizable to to my needs for appearance of the output. Speaking of customizable output, Doc-O-Matic is so flexible I was able to configure it to produce output that had nearly the same format as we were producing manually before. Another feature that I really like is how well it reads comments out of the box, and how easy it is to configure it to read any commenting style. Our developers just followed a very simple commenting format for each function in order to allow Doc-O-Matic to produce complete documentation for the function. Our developers like it too because now the API documentation is in one place - the source code. Doc-O-Matic saved me weeks of work in producing this first set of documentation for our new project, and I expect this to keep paying off in the future as I will be able to generate a complete set of documentation for each future release with very little additional work.
Joe Kroesche - Conexant Systems, Inc.
Copyright © 2000-2017 toolsfactory software inc. Alle Rechte vorbehalten.