Die Quickbook-Dienstprogramm für C ++

Quickbook ist ein Add-on für BoostBook. Dieses Programm begann als jemand Wochenende Projekt. Ursprünglich ausgegeben Quickbook einfache HTML-Dokumente. Doch jetzt gibt es XML in BoostBook-Format, so dass Sie schnell Dokumentation, die mit dem Rest der Dokumentation zu Ihrem Projekt verknüpft generieren können. Quickbook ist ein WikiWiki Stil Dokumentations.

Es ist wichtig zu beachten, dass manche Menschen einfach nennen es ein Wiki oder Wiki-Wiki oder sogar Wiki Wiki. Alle Begriffe bedeuten dasselbe.

Bevor Sie Quickbook verwenden, erzeugen Sie eine Dokumentationsdatei. Sehen Sie sich diese komplett Syntax Zusammenfassung für Quickbook.

An diesem Punkt sind Sie wahrscheinlich fragen, warum Sie Quickbook überhaupt verwenden sollte, da Sie ein Dokument-Datei für sie ohnehin zu generieren. Hier sind die Gründe, warum viele Entwickler Quickbook verwenden, anstatt direkt auf BoostBook unter Berufung:

  • Die Quickbook Syntax ist einfacher zu lesen und zu benutzen als XML zu schreiben.

  • Sie können Quickbook verwenden nicht-Boost-Dokumentation zu erzeugen.

  • Es ist relativ einfach, andere Dokumentationsformate in Quickbook-Syntax zu konvertieren.

Quickbook ist ein Kommandozeilenprogramm. Sie finden es in der Codeblocks boost_1_55_0 dist bin Verzeichnis nach dem Boost-Tools zu erzeugen. Hier sind die Befehlszeilenoptionen können Sie zugreifen, wenn sie mit Quickbook arbeiten:

  • --Hilfe: Zeigt eine Hilfemeldung alle Befehlszeilenoptionen zeigt, sowie die Befehlszeilensyntax.

  • --Version: Zeigt Versionsinformationen über Quickbook.

  • --no-Pretty-Print: Deaktiviert XML Druck und verwendet Klartext statt.

  • --Einzug arg: Definiert die Anzahl der Räume für Einzüge zu verwenden (wie von arg angegeben).

  • --Linienbreite arg: Definiert die Anzahl der Zeichen in einer einzigen Zeile.

  • --Eingabedatei arg: Gibt den Namen der Eingabedatei.

  • --Ausgabedatei arg: Gibt den Namen der Ausgabedatei.

  • --debuggen: Orte Quickbook im Debug-Modus (nur nützlich für Entwickler, die mit der ausführbaren Datei zu basteln wollen).

  • --ms-Fehler: Gibt an, dass Quickbook das Microsoft Visual Studio-Stil von Fehlern und Warnungen im Ausgabenachrichtenformat verwendet werden soll. Diese Option kann Quickbook einfacher für Microsoft Visual Studio-Entwickler zu bedienen und zu verstehen machen.

Ähnliche

Menü