Я пытался полностью задокументировать все типы, методы, свойства и т. Д. Библиотеки классов, используя XML-комментарии, но столкнулся с любопытным эффектом, связанным с атрибутом cref (например, используемым тегами see ). Следуя советам этой...

Сегодня я запустил Sandcastle Help File Builder, чтобы создать документацию для своего решения, в котором содержится около десятка проектов. Поскольку я хочу только создать документацию и запустить Sandcastle после сборки Release (которая исключает...

Я добавил тег <returns> xml в некоторые из своих методов, но не вижу его содержимого в IntelliSense. Вот мой код: /// <summary> /// we all live in a yellow summary /// </summary> /// <returns>what it...

Я ищу бесплатный инструмент для создания XML-документации в Visual Studio 2010. Я знаю документ! Х но я ищу бесплатный или аналогичный инструмент с открытым исходным кодом. Есть идеи ? Спасибо.

Я хочу добиться того же, что и в желтом поле «Примечание:» в разделе примечаний на эта страница MSDN в моей собственной документации. Я использую sandcastle и сборщик файлов справки sandcastle для создания справочного веб-сайта из тегов...

Я пытаюсь включить фрагмент кода в XML-документацию моего класса, но компилятор жалуется, что элемент xml не закрыт! Вот чего я пытаюсь достичь /// <summary> /// Method documentation here... /// </summary> /// <remarks> ///...

Кто-нибудь знает о плагине Visual Studio 2010 С#, который будет: позволяют мне легко изменить (или создать новый) шаблон комментариев xml. Мне нужно добавить в шаблон несколько пользовательских тегов. Например, когда я комментирую метод, я бы...

Каков рекомендуемый способ документирования параметров и возврата свойства Func в классе в С#, например. public class Test { /// <summary> /// A description of what AFunc is for. /// </summary> /// <remarks>...

Как я могу создать документацию моего веб-приложения C# в Visual Studio 2012, как это делает Eclipse?

У меня есть много многострочных комментариев в проекте C#, и когда параметр проекта настроен на вывод файла документации XML, все они вызывают предупреждение XML-комментарий не размещен на допустимом языковом элементе . Такое поведение наблюдается в...

Я пишу xml, используя XMLDocument в С#. при добавлении нескольких атрибутов с другим префиксом к префиксу корневого элемента не выходит в выходной XML-файл. // desired output xml <rqst xmlns="http://example.com"...

По причинам наследия я поддерживаю проект веб-сайта, для которого я хочу предоставить обновленную документацию из комментариев к документации XML. Я так понимаю, что могу сделать это, настроив раздел <compilers> в web.config . Наконец я...

1) Кто-нибудь, пожалуйста, скажите мне правильный термин для значения имени параметра XML-документации? т.е. что я называю «iNum1» и «iNum2» в строках 2 и 3 моего фрагмента кода? 2) В Visual Studio есть ли способ заставить их перестать...

У меня есть проект webapi, и я использую структуру swashbuckle для очистки документации API. Я следовал указаниям по созданию XML-файла документации с моим контроллером и DTO, и все это отлично работает локально. Однако при создании документа...

Возможно ли, что имея постоянную public const string MyString = "myValue" чтобы получить его значение myValue в комментариях xml? Меня это интересует для создания документации чванства. /// <summary> /// Creates a...