Как указать тип в комментарии XML Comment

Question

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

Пример псевдонима

родовое слово

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

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

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

Answer 1

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

<цитата>

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

Я полагаю, что официальный ответ на мой OP:В Sandcastle нет автоматического способа указания типа возврата, но, как уже упоминал Скит, можно сделать это, изменив преобразования XSL.

Answer 2

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

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

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