Как указать тип в XML-комментарии <return> комментарий

Question

В комментарии комментария 0 комментария <return> комментария к C# я хотел бы, чтобы результат (я использую Sandcastle) указывал возвращаемый тип, но я не могу узнать, как для этого.

псевдопользователей Пример:

///<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(){...} 

В приведенном выше примере это насмешка, что я думаю, сказать Sandcastle, как указать тип возвращаемого значения, описанное в Syntax разделе документации - не так.

Для наглядности приведен скриншот документации MSDN по методу GetHastCode(), который показывает тип возвращаемого изображения, для которого я стреляю.

Нужно ли вручную указывать тип или указать тип (аналогично примеру макета), и пусть Sandcastle определяет, как отображать/форматировать вывод - подобно тому, как Sandcastle автоматически отображает/форматирует параметры типа для параметров через тег <param>.

Answer 1

This post (июль 2011) имеет ответ от Эрика Вудрафф (SHFB Автор) относительно отсутствия возвращаемого типа отображается в <return> тег:

Sandcastle не оказывает информацию о типе возвращения информации, и я не думаю, что это когда-либо было. При условии, что информация в файле информации отражения , преобразования XSL могут быть изменены . У меня нет времени заглядывать в него сейчас, но может уметь в какой-то момент выяснить, возможно ли это.

Я полагаю, официальный ответ на мой ОП; Sandcastle не имеет автоматического способа указания типа возврата, но, как уже упоминалось, Skeet, он должен может быть выполненным, изменяя преобразования XSL.

Answer 2

Вы не должны указывать его в документации XML - в конце концов, это было бы излишним, учитывая, что это в объявлении метода.

Я подозреваю, что это вопрос настройки стиля Sandcastle, если вы действительно этого хотите, - но вы считаете это особенно полезным? Это не похоже на то, что пользователи не могут просто нажать на тип возврата в сигнатуре метода. (По крайней мере, это то, что, как представляется, в случае стиле прототипа в SHFB. См Noda Time documentation для примера, как это выглядит.)

В MSDN, то метод подписи не есть ссылки (по крайней мере, а не в Chrome, я не знаю, отличается ли это от IE), но лично я предпочел бы, чтобы это было в подписи вместо загромождения фактической документации.