Создание XML-примечаний к коду
Комментарии к коду ссылаются на комментарии, размещенные в файлах с исходным кодом, которые доступны пользователям интегрированной среды разработки (IDE) с помощью функции IntelliSense.
[Visual Basic]
XML-примечания к коду доступны в Visual Basic при помощи разделителя ''' (три одинарные кавычки). Дополнительные сведения см. в разделе Практическое руководство. Создание XML-документации в Visual Basic.
[C#, J#]
Для комментирования кода можно использовать XML-документацию. При аннотировании типов и членов, определенных в исходных файлах решения с комментариями XML-документации, такие комментарии будут отображаться при помощи функций IntelliSense, таких как:
Примечание
При создании комментариев к частичным методам в функциях IntelliSense отображаются только комментарии в реализации, а не в определении.
Дополнительные сведения см. в разделе Комментарии к XML-документации (Руководство по программированию на C#).
[C++]
По умолчанию все комментарии в исходном коде, использующие разделители // или /*, отображаются вслед за соответствующим членом в списке "Члены". Дополнительные сведения см. в разделах C++ Comments и XML Documentation (Visual C++).
В процессе прокрутки списка IntelliSense отображает до 12 строк комментария в окне, всплывающем под выбранным членом. При наличии более одного комментария к функции IntelliSense устанавливает, какой комментарий отображать в списке "Члены" в месте его появления в коде:
IntelliSense вначале отображает в объявлении комментарии конца строки. Например:
void MyFunction(); //EOL declaration commentsЕсли IntelliSense не находит предыдущий тип комментария, эта функция отображает комментарии, появляющиеся прямо над объявлением без промежуточных пустых строк. Пример:
//Before declaration comments void MyFunction();Если в коде не находятся комментарии предыдущих двух типов, IntelliSense отображает в описании комментарии конца строки. Пример:
int CMyAppDoc::MyVariable=2; // EOL definition commentsНаконец, если в коде не найдено ни одного комментария предыдущих типов, IntelliSense отображает комментарии, которые появляются прямо над описанием без промежуточных пустых строк. Пример:
//Before definition comments CMyAppDoc::MyFunction() { return; }