5

以下を含む C# API のドキュメントを作成しています。

  1. doc/pdf ファイルとしての現在の状態の一般的な概要と説明。
  2. Sandcastle を使用した .chm ファイル内のクラス ライブラリ API。

質問:

  1. これら 2 つを同じ .chm ファイルにマージする必要がありますか? それらをマージする良い方法は何ですか?
  2. 特定のクラス/パッケージを除外する必要があります。SandCastle でそれを指定するにはどうすればよいですか?
  3. VB コードと Visual C++ コードのドキュメントを生成します。どうすればこれを変更できますか? それとも、安全なコードのみを使用していることを知って、そのままにしておく必要がありますか?
  4. システムのどこで HTML Help 2.x Viewer Path を見つけることができますか?

編集：

上記のメソッド、フィールド、およびクラスに関するコメントは、ドキュメントには生成されません。

私は何をすべきか？

4

3 に答える 3

5

Codeplex のSandcastle Help File Builderを使用することをお勧めします。名前空間を簡単に含めたり除外したりできますが、単一のクラスを除外する方法がわかりません。public/protected クラスのドキュメントのみを生成するオプションを設定できますが、それがシナリオに適合するかどうかはわかりません。

2 番目の質問については、SHFB で特定の言語をターゲットにすることもできます。

さらに、doc/pdf ファイルにあると言及するなど、SHFB 内で MAML を概念的なドキュメントに使用できます。Doc2Mamlを使用して、既存のドキュメントを移行できるはずです。Doc2Maml は DocProject の一部ですが、スタンドアロンで実行できるようです。

コメントに応じて編集：

指示は SHFB 1.8.0.1 用です。1.7での正確な方法は覚えていませんが、似ていると思います：

  1. [プロジェクト プロパティ] タブの [コメント] グループで、[NamespaceSummaries] の右側にある省略記号をクリックします。
  2. 左上のチェックボックス リストで、除外する名前空間のチェックを外します。

これは、名前空間の概要を入力する画面でもあります。

于 2009-04-02T15:45:35.087 に答える
1

Sandcastle Help File Builder (SHFB) 自体に .chm ファイルがあり、「生成されたドキュメントから特定の名前空間またはクラスを除外するにはどうすればよいですか?」などの質問に対する回答を見つけることができます。

あなたは私が答えを知っていると思っているかもしれません。違います。しかし、私は昨夜ドキュメントをざっと読んでいて、まさにこのトピックに関するエントリを見ました.

なぜあなたが VB や C++ のものをそのままにしておかないのか、私にはわかりません。将来、あなたのライブラリで (衝撃的に) C# ではない言語を使用する人が現れるかもしれません。言語は通常、ヘルプ ビューアで設定できるため、C# 開発者は VB 構文を無視できます。

マージに関しては、SHFB には任意の HTML を任意の階層に追加する仕組みがあります。GUI では、次の場所にあります。

http://www.freeimagehosting.net/uploads/7de19ea568.jpg

これを使用すると、PDF/DOC を HTML に変換し、それを .chm に埋め込むことができます。

于 2009-04-02T15:54:15.860 に答える