Что означают теги XML «видеть» и «видеть также» в C # в Visual Studio 2010? - PullRequest
32 голосов
/ 25 июля 2010

Когда вы работаете в Visual Studio 2010, напишите комментарий к методу и нажмите Enter Visual Studio 2010 позволяет создавать XML-комментарии «видеть» и «видеть также».

Если вы наберете в комментарии «см.» И нажмете клавишу TAB, то это будет выглядеть так:

/// <see cref=""/>
/// <seealso cref=""/> 

Что это значит в C #?

Ответы [ 3 ]

31 голосов
/ 25 июля 2010

Оба тега документации XML проверены компилятором.

<see> для размещения ссылок непосредственно в тексте.

<seealso> для размещения текста в разделе «См. Также».

Посмотрите, как они используются в этом примере.

2 голосов
/ 25 июля 2010

См. И См. Также превращаются в ссылки на другие классы в сгенерированной документации в соответствии со стандартом документации .NET xml.

Пожалуйста, прочтите http://msdn.microsoft.com/en-us/library/5ast78ax.aspx для получения дополнительной информации о доступных тегах.

Обратите внимание, что в дополнение к этому Sandcaslte также поддерживает подклассы, копируя документацию из базового класса.

1 голос
/ 25 июля 2010

Эти элементы используются для создания документации.Если вы посмотрите на MSDN, вы найдете несколько ссылок в описании классов, которые относятся к другим типам.

Редактировать См. http://www.sandcastledocs.com/ в качестве примера приложения для создания этих файлов справки.1007 *

Добро пожаловать на сайт PullRequest, где вы можете задавать вопросы и получать ответы от других членов сообщества.
...