0

QtHelpに基づく組み込みのヘルプシステムをアプリケーションに実装する作業を進めています。QtHelpはQtのヘルプコレクションファイルに基づいているため、一連のHTMLページを作成する必要があります。

私はドキュメントを一人で書くことはないので（私の同僚の何人かも書くでしょう）、私はこれらのファイルを作成するための最良の方法を探しています。

私たちは内部でWikiを使用しており、ドキュメントはすべての作成者にWYSIWYG HTMLエディターを提供するのではなく、ある種のマークアップ言語で作成する必要があることを私は知っています。

だから私の質問は、HTMLファイルのセットとして、そしておそらくPDFとしてもエクスポートできるドキュメントを生成するプロセスを支援するツールはありますか？

前もって感謝します！

アップデート：

私はすでにC++ドキュメントの生成にDoxygenを使用しています。しかし、私はAPI-Documentationジェネレーターを正確に探しているわけではありませんが、LaTeXのようなものを探しています。これにより、ドキュメントの内容をマークアップドキュメント（Wikiのように）のようにフォーマットできます。

4

2 に答える 2

0

アプリケーションを JavaScript で作成している場合は、JSDoc を参照することをお勧めします。
他の言語については、Doxygen も良い選択です。 http://www.doxygen.nl/
Doxygen は HTML および PDF 形式を出力できます =)

ドキュメント ジェネレーターのより包括的なリストについては、Wikipedia と Google が役に立ちます。 http://en.wikipedia.org/wiki/Comparison_of_documentation_generators

幸運を

編集
OK、スレッドの投稿者は、すでに Doxygen を使用していると発表しました。ただし、ウィキペディアのページはまだ残っていると思います

使用している言語をお尋ねしてもよろしいですか?

于 2010-02-21T21:23:25.807 に答える
0

私は自分自身の質問に答えたくないのですが、最終的には LaTeX に落ち着くことにしました。

以前はドキュメントに Wiki (MediaWiki と DokuWiki) を使用していましたが、ドキュメントを適切な形式 (たとえば PDF ガイド) で印刷または発送しようとするとすぐに問題が発生することが判明しました。

LaTeX は Wiki マークアップ言語に比べてそれほど複雑ではありませんが、美しい PDF ファイルを生成します。また、一連の LaTeX-to-HTML コンパイラーもあり、グラフィックス、目次、クリック可能なリンクとセクションを含む適切な HTML ドキュメントを生成します。

于 2010-03-09T11:02:06.293 に答える