2

XMLコメントを使用して、クラスライブラリのすべてのタイプ、メソッド、プロパティなどを完全に文書化しようとしましたが、cref属性(seeたとえば、タグで使用される)に関連する奇妙な効果に遭遇しました。このMSDNページのアドバイスに加えて、MSDNや他のWebサイトの他のさまざまな例に従うと、crefタグを使用して参照値を指定するときは常に、参照を分類する特定のマーカー('など)をプレフィックスとして付ける必要があるようです。タイプの場合はT:'、メソッドの場合は' M:')。

ただし、Microsoft Sandcastleを使用すると、これらのプレフィックスを見逃すことにより、生成されたドキュメント(この場合はCHMヘルプファイル)に影響があることがわかりました。プレフィックスを含めると(私が信じるすべての状況で)、参照は太字のテキストとしてページにレンダリングされます...ただし、プレフィックスを除外すると、参照はAPIリファレンス内の適切なページへのアンカー(リンク)としてレンダリングされます。(すべて?)参照に接頭辞を付ける推奨される方法が最も役に立たない結果をもたらすことは私にはかなり奇妙に思えます-ある場合には参照を太字でレンダリングし、別の場合にはリンクする必要があるのはなぜですか?誰かがこれに光を当てることができれば幸いです。

4

1 に答える 1

2

これはサンドキャッスルのバグだったようです

どのバージョンのサンドキャッスルを使用していますか?

とはいえ、最近の議論は、少なくともシステム型の場合、提案された方法は、その回答で提起された例が T: と M: を完全に削除したため、修飾名の使用を実際に避けることであることを示しているようですしたがって、あなたの混乱は予想外でも珍しいことでもありません。

このドキュメントは、あなたが指しているタイプ/メソッド/定数を見つけることができるコンパイラがプレフィックスを挿入することを強く示唆しています。これをxmlで確認しましたか?

于 2009-04-25T11:01:11.650 に答える