C＃或VB文檔註釋中的粗體或斜體？

Question

有沒有辦法使用加粗或斜體裏面的文檔註釋？喜歡的東西：

/// <summary>Cleanup method. This is <b>recommended</b> way of cleanup.</summary> 
public void CleanAll(); 

List of predefined tags不包含這樣的功能，但你知道的實現重點/凸顯的一些方法？優選地，如果它可以在懸停在代碼上時在工具提示中顯示。

我們有<c>和<code>那裏，但他們已經有它們的語義。

Answer 1

不嚴格，沒有。但是，Sandcastle（從文檔生成HTML的文檔生成器）支持僅使用HTML，因此如果使用Sandcastle構建它，則可以使用<em>和<strong>。

換句話說：正如Jamiec已經注意到的那樣，XML文檔註釋只是XML。所以你可以在其中放入任何有效的XML;編譯器會高興地將它寫入文檔XML文件。這一切都取決於處理該文件的軟件。 Sandcastle只是將任何不知道的東西都作爲HTML傳遞，因爲無論如何它都是它的輸出格式。

視覺顯示幫助提示時，Studio會完全無視：

ReSharper的在其按Ctrl + Q視圖會顯示HTML標籤的文本，這使得事情有點難看：

那些通常只關心你，如果喲不過，你可以創作一個圖書館供他人使用。但這也意味着內的IDE沒有人能夠按照預期看到你的重點。

在編寫API文檔時，我發現其實很少需要強調;通常你可以用不同的方式寫出一個句子，或者重新構造一個單獨的段落中的重要節點，而不需要強調。一致的語言和措辭也可以幫助讀者在習慣使用重要筆記時選擇重要筆記。

你的代碼可能只是一個例子，但我認爲總結需要強調至少所有，因爲它只記錄 - 在一個簡短的句子中 - 一個類型或方法的作用。如果有的話，在評論中使用它，即使這樣我會仔細考慮你是否真的需要它。

Answer 2

另一種方法是使用類似維基標記的樣式。

/// <summary>Cleanup method. This is *recommended* way of cleanup.</summary> 
public void CleanAll();