問題タブ [documentation-generation]

私たちはmercurial-hgとgitを使用しており、既存のコードと新しくチェックインされたコードからドキュメントを作成する方法があるかどうか疑問に思っています。

ドキュメントを生成するmercurial-hg/gitにフックできるプラグインはありますか？

ありがとう

名前空間とモジュールを認識する Doxygen に問題があります。\addtogroupを名前空間内に配置するか、名前空間外に配置するかが問題だと思います。

例 1、名前空間の外:

例 2 - 名前空間内

namespace RecordsをDoxygen Namespacesタブの下に表示し、間接的にModulesタブの下に表示したいと思います。Namespacesページのアイテムをクリックすると、を含むページが生成されますRecords::Interface。[モジュール] タブのアイテムをクリックすると、を含むページも生成されますRecords::Interface。

私の Doxygen のドキュメントでは、このジレンマに起因する不一致のために、 モジュールにある名前空間タブに欠落している項目があり、その逆も同様です。

では、例 1 と例 2 のどちらが適切な方法でしょうか。{Doxygen マニュアルは、このトピックについて明確ではありません。}
Doxygen: \addtogroup
Doxygen: 名前空間の文書化

Microsoft Help 3 は Visual Studio 2010 に付属しています。XML ドキュメント ファイルから MSHC ドキュメント ファイルを生成するにはどうすればよいですか? Sandcastle Help File Builder を使用して CHM ドキュメント ファイルを生成していますが、CHM は少し古いものです。MS Help 3 のスキルを持っている人はいますか?

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

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

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

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

前もって感謝します！

アップデート：

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

roxygen プロセスのパッケージのデータ ディレクトリに .R ファイルを含めることはできますか?

データ ディレクトリにいくつかの .R ファイルを配置しました。データが data() で取得されると、生データ ファイルが読み込まれ、いくつかの変換が実行されます。

.NET 4を使用して、カスタムプロパティをドキュメントに追加するにはどうすればよいですか？

私はそれが次のようになると思います：

.NET4 /interopsv14に適用されるこのドキュメントが見つからないようです。

VB.NET ソース コードからプログラミング フローチャート/ドキュメントを作成するために使用するツールは何ですか? 現在、コメント/ドキュメントはまったくありません。私は初心者です。つまり、Sandcastle を試してみましたが、頭がいっぱいで、GUI を使用してもうまくいきませんでした。FatesoftのCodeVisual To FlowchartはOKなのですがコードとほぼ同じでまだコードがわかりません。

カスタム JSF 2 複合コンポーネント ライブラリのドキュメントを生成しようとしています。複合コンポーネントは、faces-config.xml ファイルでは参照されませんが、複合コンポーネントの .xhtml ファイルは META-INF/resources に格納され、新しい composite:interface タグを使用してインターフェイスを定義します。

JSP タグ ライブラリの場合、https://taglibrarydoc.dev.java.net/を使用してドキュメントを生成できます。私の JSF 2 複合コンポーネント ライブラリに同様のものがあるかどうか疑問に思っています。

私はJaxbで働いています。これらのクラスから javaDoc ファイルを生成したいのですが、通常の Java ファイルに対して行うのと同じ方法ですか?

コードドキュメントに使用例を配置するためのベストプラクティスは何ですか？標準化された方法はありますか？@usageまたは@notesで？ドキュメントジェネレータはこれをサポートする傾向がありますか？

この質問はドキュメントジェネレータに依存する必要があることを私は知っています。ただし、各ジェネレーターの特異性に入る前に、ドキュメント生成にコメントスタイルを使用する習慣を身に付けようとしています。違いよりも類似点が多いようです。

私はDoxygenを試し、AS3、JS、PHP、Obj-C、C++をよく使用します。

例えば：

また

ありがとう