參考前綴在.NET中XML文檔

Question

我一直在試圖完整記錄所有類型，使用XML註釋，但遇到了涉及cref屬性的奇怪現象方法，屬性等一個類庫（使用see標籤例如）。通過this MSDN page的建議以及MSDN和其他網站上的各種其他示例，似乎每當使用cref標籤指定參考值時，它都必須以用於分類refence的特定標記作爲前綴（例如'T ：'用於類型，'M：'用於方法）。

但是，我發現使用微軟Sandcastle時，由於錯過了這些前綴，在生成的文檔（在這種情況下是CHM幫助文件）中有一個效果。包括前綴（在所有情況下，我相信），引用在頁面上呈現爲粗體文本...然而，排除前綴引用被呈現爲API參考內的適當頁面的錨點（鏈接）。對我來說，似乎相當奇怪的是，推薦的前綴引用（all？）引用的方法是給出最少的有用結果 - 爲什麼引用應該在一種情況下呈現爲粗體而在另一種情況下被鏈接？如果有人能夠闡明這一點，我將不勝感激。

Answer 1

這似乎是一個bug in sandcastle

您正在使用什麼版本的沙堡的？

也就是說recent discussions似乎表明，至少對系統類型，建議的方法是真正避免使用限定的名字，因爲在這個問題的答案假定的例子扔下T：和M：完全你的困惑，因此並不意外或不常見。

This documentation強烈暗示編譯器，它可以指出您指向哪種類型/方法/常量，爲您插入前綴。你有沒有在xml中驗證過這個？