Вопросы по теме 'xml-documentation'
Комментарии к документации XML с интерфейсами и классами реализации
Я документирую сборку с помощью комментариев к документации XML , из которых chm файл будет создан с использованием Sandcastle .
Моя сборка содержит различные интерфейсы, каждый из которых реализован одним классом (в моем сценарии это службы...
2563 просмотров
schedule
23.01.2024
Способы синхронизации интерфейса и комментариев реализации в C #
Существуют ли автоматические способы синхронизации комментариев между интерфейсом и его реализацией? В настоящее время я документирую их обоих и не хочу синхронизировать их вручную.
ОБНОВИТЬ:
Рассмотрим этот код:
interface IFoo{
///...
30752 просмотров
schedule
28.05.2024
Где размещать комментарии XML-документации для прикрепленного свойства?
Предполагая, что у меня есть прикрепленное свойство, определенное следующим образом:
public static string GetMyProperty(DependencyObject obj)
{
return (string)obj.GetValue(MyPropertyProperty);
}
public static void...
555 просмотров
schedule
01.07.2022
Какой формат документации комментариев лучше для JavaScript?
Есть ли какой-либо формат документации комментариев для JavaScript и процессор для этого формата, который генерирует документацию HTML?
В настоящее время я использую комментарии VSDoc xml для предоставления помощи IntelliSense во время разработки,...
2931 просмотров
schedule
25.09.2023
Отделяйте документацию от кода
Я не знаю, возможно ли это, но мне интересно, есть ли способ сохранить код и документацию в отдельных файлах, но при этом работать так же, как обычно со встроенной документацией.
1227 просмотров
schedule
07.09.2022
VB.NET: как ссылаться на универсальные классы и методы в xml-документации
Примечание . Это копия этот вопрос , но для Visual Basic вместо C #.
При написании XML-документации вы можете использовать <see cref="something">something</see> , что, конечно же, работает. Но как ссылаться на класс или метод с...
926 просмотров
schedule
22.08.2023
Включите общий контент из файла документации xml
Я использую Sandcastle для создания документации по проекту. Для ссылки на файл xml-документации используется тег include .
///<include file='xml_include_tag.doc' path='MyDocs/MyMembers[@name="test"]/*' />
public class Test
И я хотел...
546 просмотров
schedule
28.04.2023
Повторная вставка XML-комментариев в дерево исходных файлов C# из автоматически сгенерированных файлов [assembly].xml
Моя ситуация: Итак, на прошлой неделе я декомпилировал сборку .NET с помощью ILSpy в C#; с тех пор я вложил массу труда в обработку файлов/проекта и т. д., чтобы все они снова работали правильно (было много мелких ошибок [в основном вызванных...
235 просмотров
schedule
29.06.2023
Анализ кода элемента активности VS2013 и XML-документация не будут компилироваться
Мы используем анализ кода в наших проектах, а также включили параметр «Файл XML-документации:» в настройках нашего проекта. Также мы установили для параметра «Рассматривать предупреждения как ошибки» значение «Все».
На вкладке анализа кода мы...
512 просмотров
schedule
11.08.2022
Как может XML-документация для веб-API включать документацию, выходящую за рамки основного проекта?
документация для включения интеграции XmlDoc в ваш веб-API. Кажется, что проекты обрабатывают только ситуации, когда все ваши типы API являются частью вашего проекта WebApi. В частности, обсуждается, как перенаправить XML-документацию на...
35924 просмотров
schedule
12.07.2022
Описание метода не отображается в другом классе
Я пытаюсь добавить описание к своему методу, но оно отображается только внутри исходного статического класса.
Пример:
/// <summary>
/// Returns A + B
/// </summary>
/// <param name="A"></param>
/// <param...
1350 просмотров
schedule
10.11.2022
В перечисляемом классе отсутствуют комментарии XML-документации в проекте .net 4.6
У меня возникает эта проблема только тогда, когда я нацеливаюсь на платформу .Net 4.6 как в Visual Studio 2015, так и в 2013. В Enumerable class нет XML Documentation Comments (System.Linq.Enumerable, \Reference...
382 просмотров
schedule
01.03.2023
IntelliSense и комментарии с тройной косой чертой в пакетах
Я разработал библиотеку кода, которую тщательно документировал.
Классы, методы и свойства комментируются с использованием комментариев XML (xmldoc) с тройной косой чертой.
/// <summary>
/// Adds two numbers together.
/// </summary>...
877 просмотров
schedule
01.06.2023
Как создать XML-документацию для CSPROJ с несколькими целями
У меня есть проект библиотеки с несколькими целями, например. в файле CSPROJ он имеет:
<TargetFrameworks>net40;net46;net461;net462;net47</TargetFrameworks>
Если мне нужна XML-документация для всех комбинаций этих целевых платформ...
12482 просмотров
schedule
24.05.2022
IntelliSense и свернутые комментарии XML не отображаются должным образом в представлении дизайна
Я пытаюсь создать комментарии XML для IntelliSense и использовать для этого следующее:
'''<summary>Units
''' <para>MinOccurs: '0'</para>
''' </summary>
Public Property S_Units As String = Nothing
В разобранном виде это...
51 просмотров
schedule
25.05.2023
Предоставляет ли Resharper дополнительные функции XML Doc для Visual Studio для класса/метода/свойства C#?
Я нашел ответ на вопрос Могу ли я создавать сводки классов и методов с помощью ReSharper
что говорит:
Если вы настроили проект для создания XML-документации, R# предложит возможность создания XML-комментариев для общедоступных участников...
278 просмотров
schedule
16.06.2023
Как я могу отформатировать XML-документацию С# как PDF или статический HTML?
Есть такой вопрос: Как для форматирования XML-документации Visual Studio для отображения в Интернете , что похоже на то, что я хочу. Но все ответы на этот вопрос очень старые, а упомянутые инструменты (песочный замок, документ, NDoc, AutoHelp)...
652 просмотров
schedule
15.02.2022
Комментарии Xml Doc во встроенных ресурсах C# в .NET (Core)
У меня есть проект С#, перенесенный из .NET Framework в .NET Core (а затем в .NET 5).
Мы вообще не трогали наши файлы .resx в течение нескольких лет, но теперь, когда я обновил файл .resx , файлы Resources.Designer.cs были сгенерированы...
145 просмотров
schedule
09.10.2022
