Sandcastleでsummaryやparamなど記述が反映されない場合の確認点

こうやって、ちゃんとClass1に対して<summary></summary>を記述して、Sandcastleを使ってAPIドキュメントを作成しようとしたところ。

 

ちゃんとClass1の<summary>をソースコード中できちんと定義しているはずなのに、Sandcastleで生成されたドキュメントに、見事に<summary>などのXMLで記述した情報が抜け落ちてしまう。

20130128191319

ハマった。

 

ググってもなかなか答えが出てこなかったため、仕方なく公式ドキュメントを読んでいると、発見。
Walkthrough: Enabling and Using XML Comments

 

プロジェクトのプロパティで、XML ドキュメント ファイルを出力するように設定しなければいけないらしい。

20130128191356

 

設定してからリビルドして、もっかいSandcastleからヘルプファイルを作成してみると、今度は見事に<summary></summary>で記述した内容が反映されていた。

20130128191512

 

ハマった原因は、使い始める時にちゃんとドキュメント読まない癖による自業自得だったとさ。

コメントを残す

トラックバック: http://pgnote.net/wp-trackback.php?p=1806