C# XML///Комментарии, где делает <возвращает> </возвраты>, тег обнаруживается?
Несколько человек упомянули, что использовали или переопределили Object.clone(). Не делайте этого. Object.clone() имеет некоторые основные проблемы, и его использованию препятствуют в большинстве случаев. Посмотрите Объект 11, от" Эффективный Java" Joshua Bloch для полного ответа. Я полагаю, что можно безопасно использовать Object.clone() на массивах типа примитива, но кроме этого необходимо быть разумными о надлежащем использовании и переопределении клона.
схемы, которые полагаются на сериализацию (XML или иначе) топорны.
здесь нет никакого легкого ответа. Если Вы хотите глубоко скопировать объект, необходимо будет пересечь граф объектов и скопировать каждый дочерний объект явно через конструктора копии объекта или статический метод фабрики что в свою очередь глубокие копии дочерний объект. Immutables (например, String с не должны быть скопированы. Как в стороне, необходимо одобрить неизменность поэтому.
4 ответа
Когда вы видите метод в 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 из этого.
Насколько мне известно, это не отображается в собственном IntelliSense Visual Studio. Но это не повод не написать что-нибудь там :-). Ctrl + Q ReSharper, например , показывает .
Остальные разделы (в основном ничего, исключение сводка ) не будут отображаться в intellisense. Они предназначены только для появления в документации, созданной из XML с использованием такого инструмента, как Sandcastle .