14
ответов
Документация кода: Сколько слишком много?
Сколько документация кода в Вашем источнике.NET слишком много? Некоторый фон: Я наследовал большую кодовую базу, что я говорил о в некоторых из других вопросов, на которых я отправил здесь ТАК. Один из "...
вопрос задан: 13 November 2008 21:36
9
ответов
Комментарий кода: Вы помещаете свои комментарии к коду на Интерфейсы или на Реальные классы или обоих? [дубликат]
Что является лучшей практикой в документировании классов и интерфейсов. Скажите, есть ли у Вас реальный класс по имени Foo, который происходит из интерфейса под названием IFoo. Куда Вы помещаете свои комментарии для Вашего...
вопрос задан: 9 December 2009 17:58
7
ответов
Как иметь комментарии в IntelliSense для функции в Visual Studio?
В Visual Studio и C#, при использовании созданного в функции, такой как ToString (), IntelliSense показывает желтое поле, объясняющее, что это делает. Как у меня может быть это для функций и свойств, которые я пишу?
вопрос задан: 28 February 2019 20:03
6
ответов
.Net XML comment в документацию API
Существует ли простой способ произвести документацию стиля MSDN из Visual Studio вывод XML? Я не достаточно терпелив для установки хорошего xslt для него, потому что я знаю, что я не первый человек, который пересечет это...
вопрос задан: 25 June 2014 19:54
6
ответов
Каковы достоинства использования XML-комментариев в.NET?
Я не могу понять достоинства использования XML-комментариев. Я знаю, что они могут быть преобразованы в хорошую документацию, внешнюю к коду, но то же может быть достигнуто с намного более кратким синтаксисом DOxygen...
вопрос задан: 6 April 2010 13:44
6
ответов
XML Комментарий подсказок для [закрытого] программирования C#
Доброе утро, день, вечер или ночь (в зависимости от Вашего часового пояса). Это - просто общий вопрос о XML, комментирующем в C#. Я никогда не был очень крупным в комментарий моих программ, я имею...
вопрос задан: 10 December 2008 12:58
4
ответа
В какой точке настройки Stylecop прекращают быть полезными и начинают становиться раздражающими?
Я работаю в команде, где мы используем обширный ruleset в StyleCop, и я задаюсь вопросом, что является мыслями об общей точке, где такой инструмент прекращает быть полезным и запускается, становится раздражающим. Мы также используем...
вопрос задан: 8 July 2010 14:05
4
ответа
C# XML///Комментарии, где делает <возвращает> </возвраты>, тег обнаруживается?
Я в настоящее время - студент программирования, и очевидно мой вопрос прост, но я не был в состоянии найти ответ на него онлайн. Таким образом, здесь это: В XML///комментирует в C#, где делает <...
вопрос задан: 4 December 2009 07:21
3
ответа
Используя XML-комментарий C# cref приписывают с синтаксисом параметрических усилителей
В C# я пытаюсь использовать <видят cref = "вздор"/> для ссылки на сигнатуру метода, которая содержит ключевое слово параметрических усилителей. Я знаю, что это преобразовывает список параметров в массив, но я не могу даже выяснить...
вопрос задан: 10 August 2018 10:09
3
ответа
Мультилиния XML комментирует в C# - что я делаю неправильно?
В соответствии с этой статьей, возможно получить многострочные XML-комментарии - вместо того, чтобы использовать///, использовать / ** */. Это - моя интерпретация того, что многострочные комментарии, и что я хочу иметь, произойдите:/...
вопрос задан: 12 August 2014 07:10
3
ответа
Как я настраиваю автоматический текст комментария в Visual Studio?
Когда я ввожу триггер автоматическая функция комментария в Visual Studio (путем ввода "'''" или "///"), большинство XML, комментирующие детали разоблачают это, мне нравится. Однако я обычно добавляю тег истории к...
вопрос задан: 15 September 2010 15:27
3
ответа
Нахождение пропускающий содержание XML-комментариев с Visual Studio
Повсюду или исходный код C# у нас есть много комментариев, которые пропускают фактическое содержание такое как это:///<сводка>///</сводка> или это:///<сводка>//////</сводка> или...
вопрос задан: 11 November 2008 16:25
2
ответа
Web.config: поместите комментарий в атрибутах XML
Я хочу поместить комментарий в web.config файл, что-то вроде этого: <httpRuntime requestValidationMode = "2.0"//требуют для [ValidateInput (ложь)] в .net 4.0 requestPathInvalidCharacters =...
вопрос задан: 16 May 2010 08:01
2
ответа
ConfigurationManager может сохранить XML-комментарии на Сохранении ()?
Я записал маленькую утилиту, которая позволяет мне изменять простой AppSetting для файла другого приложения App.config и затем сохранять изменения://сохраняют резервную копию сначала. var cfg =...
вопрос задан: 23 December 2009 19:05
2
ответа
коллапс с практическими рекомендациями все XML-комментарии в Studio Visiual 2008
я задавался вопросом, существует ли плагин, дополнение или какой-либо другой простой способ избавиться от чрезмерно увеличенных в размерах комментариев xml для c#? Компания хочет документацию, но в моей ежедневной работе комментарии просто...
вопрос задан: 18 August 2009 13:48
2
ответа
Действительно ли возможно викифицировать XML-комментарии Visual Studio?
Действительно ли возможно генерировать ряд страниц Wiki из файла XML-комментария, сгенерированного Visual Studio? Я говорю о чем-то как Замок из песка, но для формата Wiki вместо скомпилированного CHM.Править: Я...
вопрос задан: 10 July 2009 13:12
2
ответа
Что filterpriority отмечает в XML-комментарии, делают?
Я видел это в большом количестве XML-комментариев для классов в Платформе.NET BCL, но никогда не был в состоянии найти документацию, которая объясняет, что это делает. Как пример, смотря на Систему. Объект...
вопрос задан: 7 January 2009 21:33
2
ответа
Как связаться / перегрузки группы в XML-комментариях C#?
В XML documentaiton комментарии для C#, там способ отметить две или больше функции, чтобы быть перегрузками друг друга, так, чтобы они сослались друг на друга автоматически? Идеально, они были бы также сгруппированы в...
вопрос задан: 26 December 2008 12:09
2
ответа
Добавьте XML-комментарии для классификации свойств, сгенерированных LINQ разработчику SQL
Я привык LINQ для разработчика SQL в Visual Studio для создания объектной модели базы данных. Теперь, я хочу добавить XML-комментарии к каждому сгенерированному свойству, но я не могу выяснить, как сделать это без...
вопрос задан: 11 November 2008 16:26
1
ответ
XML-комментарии, не появляющиеся в Сервисе WCF
У меня есть обслуживание WCF и комментарий моих контрактов на операцию как указано ниже:///<сводка>///Вызов к topup карта.///</сводка>///<имя параметрического усилителя = "topUp"> объект TopUp...
вопрос задан: 15 June 2011 14:28
1
ответ
XML-комментарии <список>, не отображающийся в IntelliSense
Я пытаюсь заставить XML-комментарии VB.NET работать с IntelliSense, и возможно он не прокладывает себе путь, я думаю, что он делает. ''' <сводка>' '' Получает или устанавливает Код Пациентов. ''' <список...
вопрос задан: 17 July 2010 15:38
1
ответ
Каковы объекты поддерживаемого символа для XML-комментариев?
В следующем примере, & и Δ в порядке, но Δ не (последние два оба Δ). Компилятор выпускает предупреждение, подобное: предупреждение CS1570: XML-комментарий на 'XXX...
вопрос задан: 2 October 2009 20:06
1
ответ
Ссылочный универсальный комментарий
Я задавался вопросом, возможно ли сослаться на динамическое универсальное имя класса в комментарии, и это условно решило в IDE? Простой пример базового класса://<сводка>//Получает все...
вопрос задан: 30 May 2009 23:17
1
ответ
Отрывок XML-комментария значения по умолчанию изменения в Visual Studio
То, когда я поразил///в Visual Studio, является этим возможный изменить получающийся отрывок от этого:///<сводка>//////</сводка> к этому?:///<сводка> </сводка>
вопрос задан: 25 December 2008 11:16
0
ответов
Следует ли писать XML-комментарии для интерфейсов, конкретных реализаций или того и другого? [закрыто]
Меня интересует, где я могу применить свои XML-комментарии. Должен ли я добавить более общий XML-комментарий в интерфейс и более описательный в реализующий класс? Как это: открытый интерфейс ...
вопрос задан: 24 November 2019 17:23
0
ответов
Visual Studio - Сводка комментариев тега - Дополнительные параметры
При указании сводных элементов комментариев, есть ли способ с тегом , чтобы отметить, что параметр необязательно, Т.е. клиент может поставлять значение или нуль, например:
вопрос задан: 14 June 2018 16:48
0
ответов
с помощью см. cref с символами <> в документации XML? [дубликат]
Возможный дубликат:Как ссылаться на общие классы и методы в xml-документации. Я использовал тег see cref, и он отлично работает, но теперь мне нужно включить общий список string [] в ...
вопрос задан: 23 May 2017 12:34
0
ответов
Многострочные комментарии XML в VB.NET и Visual Studio Intellisense
Я пытаюсь вставить новые строки в свои комментарии XML в VB.Net. Я прочитал два других сообщения о C #, многострочные комментарии XML в C # - что я делаю не так? Добавление разрывов строк в комментарии для Intellisense ...
вопрос задан: 23 May 2017 12:08
0
ответов
VS2010: автоматически сгенерированные файлы и документация XML
Это просто повторный вопрос, заданный для Visual Studio 2008. Предлагает ли VS2010 какую-либо функцию, чтобы избавиться от предупреждения компилятора CS1591 для авто сгенерированный код? CS1591: отсутствует XML ...
вопрос задан: 23 May 2017 12:01
0
ответов
Visual Studio Отключение предупреждения об отсутствии комментария XML
У меня есть проект с более чем 500 предупреждениями об отсутствии комментария XML. Я знаю, что могу удалить функцию комментариев XML или вставить везде пустые фрагменты комментариев, но я бы предпочел универсальное решение, в котором я могу ...
вопрос задан: 26 July 2016 08:15