問題タブ [sandcastle]

Sandcastle には、 2007 年の素敵なイントロで説明されているように、Conceptual Helpを生成するためのかなり複雑な XML MAMLがあります。コンテンツの書きやすさとページ生成の制御という点で、これは Doxygen と比べてどうですか?

私は、Doxygen のページ機能を使用して、設計上の問題の議論を含む概念的なヘルプを作成するのが大好きです。メインページがあり、サブページまたは参照コマンドを使用してリンクを追加することにより、ページをグループ化する方法を選択できます。

また、インライン フラグメントを使用するか、外部ファイルを参照して、カジュアルな Graphviz ダイアグラムを dox​​ygen ページに含めることができるという事実も気に入っています。

サンドキャッスルのドキュメントに、列挙メンバーに配置されたコメントが欠落していることに気付きましたが、ビジュアル スタジオによって作成された XML ドキュメント ドキュメントには欠落しているデータが含まれています。

多くの要素が他の要素から継承される複雑なクラス構造があるとします。インターフェイスで定義されたメソッドがありGetStuff(string stuffName, int count)、それが他のインターフェイスに継承され、抽象クラスによって抽象的に実装され、具体的なクラスで明示的に実装されるなど...

GetStuff()Doxygen や Sandcastle などのツールで使用される XML コメントでコードを文書化する場合など、継承されたメンバーをどのように処理すればよいですか? 各レベルで同じ説明をコピーして貼り付けるのは間違っているようです。インターフェイス レベルと具象クラス レベルで異なる対象者を検討する必要がありますか? たとえば、インターフェイスの GetStuff() のドキュメントでは、インターフェイスを実装する人を考慮する場合がありますが、具象レベルのドキュメントでは、代わりにクラスを使用する人を考慮する場合がありますか?

私のライブラリはコードコントラクトを使用しています。

サンドキャッスルによって生成されたドキュメントにこれらの契約を組み込む方法はありますか？

サンドキャッスルプロジェクトにコードスニペットを追加しました。ただし、コードスニペットは結果のヘルプファイルに表示されませんか？追加することを指定するにはどうすればよいですか？

Sandcastle で CHM / HTML ドキュメントを作成するには? XML から HTML ファイルを作成できますか、それとも .cs および dll ファイルを使用する必要がありますか?

コメント ジェネレーター (具体的にはサンドキャッスル) からテキストを非表示にできる XML コメント タグがあるかどうかを知っている人はいますか?

たとえば、次のようになります。

... タグ間のテキストがサンドキャッスルで生成された出力に表示されないようにしたいと思います。

何かご意見は？

Sandcastle HelpFileBuilderを試しています。GUIからビルドを実行すると、次のエラーが発生します。

C：\ Program Files \ MSBuild \ Microsoft \ VisualStudio \ v9.0 \ WebApplications\Microsoft.WebApplication.targets"が見つかりませんでした

これは、C：\ Program Files（x86）ディレクトリにあるためです。

では、代わりにそのディレクトリを使用するように構成するにはどうすればよいですか？

サンドキャッスルを使用してヘルプファイルを認証しています。

Visual StudioのASP.NETやXAMLとは異なり、インテリセンスのサポートがないため、AMLファイルの編集は面倒です。

もっと良い方法はありますか？

サンドキャッスルを使用してヘルプ ファイルを作成しています。

実際の C# ファイルからコード サンプルを追加する方法はありますか? 理想的には、地域を含む C# ファイルを用意し、sandcastle から地域を参照します。Sandcastle は、ビルド時にリージョンのコンテンツを埋め込みます。これは実現可能ですか？