wcf - SandCastle を使用して WCF ドキュメントを生成する

Question

SandCastle を使用して WCF サービスの外部ドキュメントを生成しようとしています。SandCastle にServiceContract、アセンブリ内の名前ではなく、関数やエンティティの名前付けなどの WCF 属性を使用するように指示するにはどうすればよいですか?

Answer 1

OK、以下はあなたの質問に対する直接的な回答ではありませんが、何らかの形で役立つかもしれません.

「外部サービス ドキュメント」を作成したいと言っている場合、その外部ドキュメントはおそらく .NET 開発者向けではなく、その実装の詳細を (必然的に) 目に見えるようにしたくないかもしれません。したがって、典型的な API スタイルのドキュメントはいずれにしても適切ではない可能性があります。

API スタイルのドキュメントに加えて、Sandcastle は「概念ドキュメント」と呼ばれるものもサポートしています。もちろん、特定のXMLの方言では、これは基本的に「フリーテキスト」です。それについては後で説明します。

まず、サービス インターフェイス用の WSDL ファイルを生成します (通常は?WSDL、サービスの URI に追加するかSVCUTIL.EXE、サービス アセンブリで使用します。これは、自動ビルド時に適しています)。

次に、難しい部分があります。WSDL をMAMLドキュメントに変換するものを作成する必要があります (XML スタイルシートが思い浮かびます)。MAML (Microsoft Assistance Markup Language) は、実際にはサンドキャッスルが使用するいわゆるコア フォーマットです。

Sandcastle Helpfile Builderを使用してこれらのファイルからプロジェクトを作成し、そこから CHM、HTML ページなどを作成するのが最善の策だと思います。

基本的に、MAML ドキュメントを取得したら、「標準の」Sandcastle ツール チェーンに戻ります。

私はそれがかなりの仕事のように聞こえることを知っています、そしておそらくそうです. 私は過去に、SMO を使用して SQL Server データベースにクエリを実行し、テーブル、プロシージャなどの MAML ドキュメントを生成して参照ドキュメントを生成するという、同様のことを行ったことがあります。実際、それは非常にうまく機能し、最終的には努力はそれほど悪くはありませんでした.

とにかく、「既製の」ソリューションが実際に存在する場合に備えて、その質問を見つめ続けます:-)