В настоящее время я участвую в программировании, и, очевидно, мой вопрос прост, но я не смог найти ответ на него в Интернете. Итак, вот оно:
В комментариях XML///на С#, где появляется тег <returns>, я знаю, что все, что содержится в теге <summary>, появляется в intellisense, когда вы наводите указатель мыши на вызов метода, но не возвращает тег.
Итак, где находится тег <returns>?
Спасибо.
Когда вы видите метод в View → Object Browser
Например, вы увидите что-то вроде этого:
private int GetColumnIndex(Microsoft.Office.Interop.Excel.Worksheet worksheet, string columnName, int rowIndex, int startColumnIndex)
Member of MyAddIn.CommandHandlers.CommandHandler
Summary:
Returns the column index with specified name and in specified row
Parameters:
worksheet: Target worksheet
columnName: Column name to find
rowIndex: Row index in which to search the column
startColumnIndex: Start index of the column
Returns:
The index of column if found, else returns 0
Если вы создадите документацию API из комментариев, она появится в разделе "Возвращаемое значение", как показано здесь, прямо перед разделом "Примечания".
Когда вы выбираете сборку файла документации XML при компиляции, тогда все, что содержится в комментариях документации XML, копируется в этот файл. Такие программы, как Sandcastle, затем могут создавать HTML-документацию, родственную MSDN.
Он не показывает в Visual Studio собственный IntelliSense, насколько я знаю. Но это не оправдание, чтобы ничего не писать:-). Например, ReSharper Ctrl + Q показывает это.
Другие разделы (в основном исключение summary) не будут отображаться в intellisense. Они предназначены только для того, чтобы появляться в документации, созданной из XML, с помощью инструмента, такого как Sandcastle.
Когда кто-то посещает ваш код, он увидит комментарий, прямо там, где вы его оставили. Так что да, немного очевидная, но действительная точка.