問題タブ [sandcastle]

xmlコメントを使用するC＃プロジェクトがあります。Sandcastleヘルプファイルビルダーを使用して、Sandcastleでそれらからchmファイルを作成します。このプロジェクトのメンバー関数の1つは、埋め込まれたリソースを利用します。ヘルプファイルで参照したい。sandcastleはこれをサポートしていないようですが、解析するxmlドキュメントファイルはサポートしています。私は次の例のためにこれを言います

そのコードをコンパイルし、結果のxmlドキュメントからchmをコンパイルすると、ビルドログに次のようになります。

そして、備考セクションは次のとおりです。

ReSharperのAgentSmithが提案し、 <see/>要素をビルドログに変更すると、次のようになります。<see cref="Resources.TextFile"/>

そして、chmの備考セクションは次のように変更されます。

だから私の質問は2つの部分です：

1. リソースを参照するための<see/>要素の使用は正しいですか？
2. サンドキャッスルが生成するchmファイルに埋め込まれたリソースを参照するようにする方法はありますか？

クラス ダイアグラムを Visual Studio からイメージとしてエクスポートするには、サーフェスを右クリックして [ダイアグラムをイメージとしてエクスポート...] を選択します。

コマンドラインからこれを行う方法はありますか? すべてのクラス図を画像として生成できるようにして、Sandcastle で構築している .chm に含めることができるようにしたいと考えています。

.chm ファイルであるサンドキャッスルを使用して、プロジェクトのヘルプ ファイルを生成しました。しかし、コンテンツは自分のマシンで開いたときにしか見ることができません。私はそのファイルを何人かの友人に渡しましたが、誰もファイルの内容を見ることができません。何が間違っていますか?? どうすれば解決できますか?? 私の設定に問題はありますか?? みんな助けてください!!!

よろしく、ランガナ。

HTML ヘルプ ファイルを作成できるように、C# コードをコメントで装飾しています。

私はよくインターフェイスを宣言して文書化します。ただし、これらのインターフェイスを実装するクラスは、実装に応じて特定の例外をスローできます。

場合によっては、クライアントは自分が使用しているインターフェイスしか認識していないことがあります。実装者によってスローされる可能性のある例外を追加して、インターフェイスを文書化する必要がありますか?

インターフェイスの実装者がフレームワークのものではなくこれらをスローするように、カスタム例外を作成/文書化する必要がありますか?

これが明確であることを願っています！

ありがとう

編集 2010 年 1 月 4 日: http://blog.mikecouturier.com/2010/01/creating-custom-exceptions-in-net-right.htmlで、これと .NET のカスタム例外に関するブログ投稿を書くことにしました。

今日、Sandcastle Help File Builder を起動して、ソリューションのドキュメントを生成しました。このソリューションには、約 12 個のプロジェクトが含まれています。ドキュメントを生成し、リリース ビルド (すべてのテスト プロジェクトを除外) の後に Sandcastle を実行したいだけなので、VS の場合と同様に、ウィンドウの上部で [リリース] を選択しました。Sandcastle は、各プロジェクトの \bin\release サブフォルダーで生成された XML ファイルを適切に探します。ただし、テスト プロジェクトの DLL が見つからない場合、エラーが発生します。ソリューション ファイルにこれらのプロジェクトが表示されているようですが、リリースにそれらのビルドがないことを認識していません。「API フィルター」プロパティでそれらの選択を解除しようとしましたが、何も変わりません。

Sandcastle にこれらのプロジェクトを無視させるにはどうすればよいですか?

Sandcastle Help File Builder を使用してオープン ソース プロジェクトのドキュメントを作成していますが、次の 2 つの問題に直面しています。

• ドキュメントの内容はフランス語です。SHFB プロジェクトで言語をフランス語に設定しましたが、生成されたテキストのほとんどはまだ英語です (「プロパティ」、「継承階層」、「参照」...)。SharedContent フォルダーにローカライズされたファイルがいくつかあることを確認しましたが (実際には完全にローカライズされていません)、翻訳できるのはごく一部、主に詳細 (フィードバック、免責事項、プライバシーに関する声明など) のみです。残りのテキストをローカライズするにはどうすればよいですか? Visual Studio 2008 の英語版があることに注意してください。それは問題になるでしょうか？

• ドキュメントは HTML として生成され、Linux/Apache サーバーでホストされます。残念ながら、Sandcastle によって生成される多くのファイル名は大文字と小文字が一致していないため、Linux サーバーでは機能しません。たとえば、「Index.html」は Apache によってデフォルトのドキュメントとは見なされず (「index.html」である必要があります)、大文字と小文字が間違っているために CSS ファイルが見つかりません...手動で大文字と小文字を修正することもできますが、ドキュメントを再構築するたびに、もう一度やり直す必要があります。その問題に対する既知の解決策はありますか? Linux サーバーで Sandcastle によって生成されたドキュメントをホストするのは私が初めてではないと思いますが、それに関する有用な情報は見つかりませんでした...

ご協力いただきありがとうございます

私たちの開発チームは現在asp.net 2.0を使用しており、多くのブラウジングとクロスサイト参照の後、新しいものはasp.net MVCであることがわかりましたが、aspのサポートなど、できないことがいくつかあることがわかりました.net コントロール、ビュー ステート。

各ページが特定のビューにリンクされるコントローラーにリンクするパラダイムの全体的な変更以外に、他の制限が何であるかはわかりません。そのため、学習曲線を緩やかにするために、最初に MVP を取り上げたいと思いました。アプリケーションとドメイン層を取り出してテスト可能にするだけで、プロセス全体にとってすでに大きな助けになっていると思います。面倒すぎることなく。

さらにブラウジングした後、ndoc が少し古くなっていることがわかりました。これは、コード内のドキュメントの自動生成を非常にうまくカバーするように、docproject 呼び出しで追加のアドインを持つサンドキャッスルに置き換えられています。

受け入れテストを処理するために、FITに基づいたこのツールコールfitnesseが役立つはずです。

これらすべてにまったく慣れていないので、チームの開発プロセスをカバーするためにこのツールを使用するのが全体的に良いプロセスであるかどうか疑問に思っています. そして、これらのすべてのステップをカバーし、いくつかのツール、つまりフレームワークを使用してギャップを埋めようとするよりも優れた仕事をする他のサンプル/リソース/フレームワークがそこにある場合は?

1. 基本的に私の質問は、私が調査したツールによって上記の全体的なプロセスが十分にカバーされているかどうかです。

2. asp.net tdd + 自動ドキュメント生成 + 受け入れテストを行うより良い方法はありますか?

アドバイス/フィードバックをお待ちしております。ありがとう！！:)

プロジェクト内のクラスごとに、SandCastle は (とりわけ) 2 つのページを作成します。

• と呼ばれるメイン ページにはT_class_full_name、構文、継承階層、および関連項目の説明が含まれています。
• AllMembers_T_class_full_nameコンストラクター、メソッド、フィールドなどを含む、と呼ばれるメンバー ページ。

これら 2 つをマージしmembers pageて、メイン ページに追加する方法はありますか?

私はいくつかの古いコードにアクセスしていますが、次のように、EventHandler <T>を使用するのではなく、デリゲートで手動で宣言されたイベントがかなりあります。

サンドキャッスルを使用してライブラリを文書化するまでは、イベント宣言によって生成されたプライベートの追加フィールドのXMLコメントが見つからないためです。私はそれを整理してみたいのですが、私がしたいのは次のいずれかです。

• すべてのプライベートフィールドを完全に無視するように指示せずに、自動生成されたプライベートフィールドを無視するようにサンドキャッスルを取得します

また

• プライベートフィールド用に生成されたXMLコメントを取得します

コードを次のようにリファクタリングせずにこれを実現する方法はありますか？