.NET XMLドキュメンテーションコメントには、サンドキャッスルのディレクティブが含まれていませんヘルプファイルに追加

StackOverflow https://stackoverflow.com/questions/9510477

質問

は面白いものを持っています。C#でXML文書コメントを使用してメソッドを文書化しています。参照ファイルのすべての内容を含めるには、ディレクティブを使用します。私はXML文書としてフォーマットされた文字列を受信するコードを文書化しています。のXSDファイルを含めたいです。

Visual Studioによって生成されたXMLが私が期待しているとおりに機能します。これがXMLのスニペットです:

    /// <param name="xml">XML string - see Test.xsd <include file="XSD/Test.xsd" path="/*"/> After file include</param>
.

しかし、これからSandcastleを使用してヘルプファイルを生成すると、XSDファイルの内容は表示されませんが、Sandcastleはエラーを報告しません。私は、ヘルプファイルのどちらのものと比較してファイル名を使用しようとしました、すなわち

しかし、Visual Studioがファイルが見つからないと文句を言う。私はそれらを両方の場所に置き、それでも含まれているファイルは表示されません。

任意のアイデア?

役に立ちましたか?

解決

The include tag is processed at compiler time, so the generated XML file should contain all of its referred contents. Hence you have to put your XSD folder relative to the C# source file, then the compiler won't show any errors. After this, Sandcastle will be able to create the help file from the single XML document.

ライセンス: CC-BY-SA帰属
所属していません StackOverflow
scroll top