#c_sharp #enum
Есть описанное перечисление. Например: public enum Duration { S , D, F } Необходимо, чтобы в сплывающих подсказках автозаполнения было описание каждого элемента.. Вот как это выглядит сейчас. Хотелось бы, чтобы выглядело как тут: В сплывающей подсказке поясняется что означает данный элемент перечисления. Как подобное описание добавить к своим enum? Нужно, чтобы описание было доступно в стороннем проекте при подключении данного (переносимая библиотека) в виде собранного dll.
Ответы
Ответ 1
public enum Duration { ////// Text /// S, ////// Text /// D, ////// Text /// F }Ответ 2
Вот так: public enum Duration { ////// Это S /// S, ////// А вот это D /// D, ////// А вот тут вообще F /// F }Ответ 3
Для того, чтобы документация из внешней dll работала в сторонних проектах, необходимо включить генерацию XML-документа при сборке. По умолчанию создание xml-файла из комментариев отключено. Его нужно включить в свойствах проекта на вкладке Build. В результате при компиляции, в дополнение к файлу вашей сборки, будет сгенерирован xml-файл, который содержит все xml-комментарии из кода (в том числе комментарии к непубличным структурам). Этот файл уже сам по себе полезен тем, что если его положить рядом со сборкой (вашей dll), то это позволит функции IntelliSense в Visual Studio отображать описания для методов в момент набора пользователем кода. Информация взята из статьи: https://habrahabr.ru/post/102177/ Там также есть прочая полезная инфа по составлению документации на C#
Комментариев нет:
Отправить комментарий