2014-10-10 20 views
1

任何曾經嘗試爲文檔註釋的 中的某些通用代碼編寫示例的人都知道,如果您不希望 與標籤混淆,那麼它可能相當困難。有什麼辦法可以做到嗎?對於C#doc註釋中的泛型示例,是否可以使用< & >?

+0

某些MSDN文檔使用括號(例如'List(T)')。只是一個猜測,但也許這就是它的做法? – 2014-10-10 05:44:05

+1

@PlatinumAzure在vs2013 >和<工作正常 – 2014-10-10 05:52:53

回答

2

或者你可以使用CDATA如果你有一個更大的多行例子,你不想逃避每個<> &和」的評論將會更具可讀性,以及例如:。

/// <code><![CDATA[ 
/// List<int> mylist; 
/// ]]></code> 
+1

方式更可讀的多行評論,很好!你知道是否有辦法讓CDATA'

'和''也可以通過IntelliSense顯示評論? – 2014-10-10 22:58:07

4

您應該可以使用&lt;&gt;,因爲C#doc註釋是XML。

+0

是的,我剛剛證實,這按照預期工作 – 2014-10-10 05:50:21

相關問題