如何在XML註釋中指定類型<return>評論

在我的C＃XML評論的<return>評論中，我希望輸出（我正在使用Sandcastle）指定返回的類型，但我無法找出如何要做到這一點。如何在XML註釋中指定類型<return>評論

的僞例：

///<summary> 
///Serves as a hash function for a particular type. 
///</summary> 
///<returns **Type="System.Int32"**> 
///A hash code for the current Object. 
///</returns> 
public virtual int GetHashCode(){...}

上面的例子是我的猜測是，告訴沙堡怎樣來指定記錄在文檔中的Syntax部分的返回類型是什麼一個模擬 - 並非如此。

爲了清楚起見，這裏是GetHastCode()方法表明，我拍攝的返回類型的MSDN文檔的截圖。

我們必須手動指定類型，還是可以指定類型（類似於模擬示例），讓Sandcastle確定如何顯示/格式化輸出 - 類似於Sandcastle自動顯示/格式化參數類型通過<param>標籤。

enter image description here

來源

2012-02-21 Jed

但是，要使「對象」這個單詞成爲相關類型的引用，您需要編寫如下代碼：'///當前<參閱cref =「Object」/>的哈希代碼。' – 2016-09-14 12:54:31

我想也知道這一點，我有一個使用'JsonResult '的API，但T是一個匿名類型。我試圖指定除動態運行以外的其他類型的錯誤。 – Andrew 2017-02-10 17:00:02

This post（2011年7月），有來自埃裏克·伍德拉夫（SHFB作者）對缺乏返回類型的響應<return>標籤中顯示：

沙堡沒有渲染的返回類型信息信息，我不認爲它曾經有過。如果反射信息文件中的信息是，則XSL轉換可以被修改爲以呈現它。我現在沒有時間查看它，但可能在某些時候發現它是否可能。

我想官方回答我的OP是;沙堡沒有指定返回類型的自動方式，但是，像斯基特已經暗示，它可能可以通過修改XSL轉換來實現這一目標。

來源

2012-02-24 22:38:20 Jed

你不應該需要在XML文檔中註明了 - 畢竟，這是多餘的，因爲它是在方法聲明。

我懷疑這是調整的沙堡風格的，如果你真的想一個問題 - 但是你覺得特別有用嗎？這不像用戶不能單擊方法簽名中的返回類型。（至少，這似乎是在SHFB原型風格的情況下。見Noda Time documentation爲看上去是什麼樣的例子。）

在MSDN，那麼方法簽名不有鏈接（至少不在Chrome中;我不知道它在IE中是否有所不同），但個人而言，我更喜歡它是在簽名而不是混淆了實際的文檔。

來源

2012-02-21 23:40:02

我聽到你@多餘。我從MSDN/Sandcastle冗餘地指定參數部分中的類型的角度出發，我認爲還有一種內置的方式來爲返回值指定類型。 – Jed 2012-02-22 00:00:21

如何在XML註釋中指定類型<return>評論

回答

相關問題