Nano Hash - криптовалюты, майнинг, программирование

Создание документации C# без создания документа Xml

Прежде всего, я видел Создание документации из комментариев C# XML и многие другим это нравится, но ни один из предложенных инструментов не работает для того, что мне нужно.

Мне нужен бесплатный инструмент, который может генерировать документацию (желательно в формате html) из моего исходного кода без использования документа xml, созданного Visual Studio. В проекте есть предупреждения о включенных ошибках, и проверка опции создания этого XML-файла приводит к сотням ошибок. По сути, это исключает 90% генераторов документации C#, включая Sandcastle, NDoc3, Live Documenter, docu и ImmDoc.

Doxygen почти работает, но я не могу заставить его генерировать документацию для перегруженных универсальных классов, таких как:

public class MyClass<Foo>
public class MyClass<Foo, Bar> : MyClass<Foo>

У MyClass есть документация, а у MyClass нет.

Тогда вопрос - есть ли:

  1. генератор документации, который я не видел, который может справиться с этим случаем,
  2. параметр конфигурации в одном из перечисленных мной инструментов, который заставит его работать, не требуя файла xml-документации,
  3. или даже способ отключить просто предупреждения компилятора комментариев, не влияя на предупреждения сборки?

Редактировать. Решение с помощью метода № 3 состоит в том, чтобы подавить следующие предупреждения, относящиеся к комментариям xml: 1570, 1571, 1572, 1573, 1574, 1580, 1581, 1584, 1587, 1589, 1590, 1591, 1592, 1598, 1710, 1711, 1712, 1723

09.12.2010

Ответы:


1

Вы можете отключить предупреждение 1591 в свойствах проекта, а затем сгенерировать XML.

09.12.2010
  • Хотя это избавляет от большинства ошибок, есть несколько других предупреждений о комментариях. Чтобы это было правильным решением, мне нужно отключить все предупреждения, связанные с комментариями. Эта страница msdn была полезна в нахождение остальных. Маркировка как решение для указания мне в правильном направлении =) 10.12.2010
  • @GStepanov: Вы должны просто исправить другие. Это настоящие ошибки, и исправить их не составит труда. 10.12.2010
  • К сожалению, я не владею проектом; если бы я это сделал, я бы исправил их и не публиковал это в первую очередь. 10.12.2010
  • Новые материалы

    Кластеризация: более глубокий взгляд
    Кластеризация — это метод обучения без учителя, в котором мы пытаемся найти группы в наборе данных на основе некоторых известных или неизвестных свойств, которые могут существовать. Независимо от..

    Как написать эффективное резюме
    Предложения по дизайну и макету, чтобы представить себя профессионально Вам не позвонили на собеседование после того, как вы несколько раз подали заявку на работу своей мечты? У вас может..

    Частный метод Python: улучшение инкапсуляции и безопасности
    Введение Python — универсальный и мощный язык программирования, известный своей простотой и удобством использования. Одной из ключевых особенностей, отличающих Python от других языков, является..

    Как я автоматизирую тестирование с помощью Jest
    Шутка для победы, когда дело касается автоматизации тестирования Одной очень важной частью разработки программного обеспечения является автоматизация тестирования, поскольку она создает..

    Работа с векторными символическими архитектурами, часть 4 (искусственный интеллект)
    Hyperseed: неконтролируемое обучение с векторными символическими архитектурами (arXiv) Автор: Евгений Осипов , Сачин Кахавала , Диланта Хапутантри , Тимал Кемпития , Дасвин Де Сильва ,..

    Понимание расстояния Вассерштейна: мощная метрика в машинном обучении
    В обширной области машинного обучения часто возникает необходимость сравнивать и измерять различия между распределениями вероятностей. Традиционные метрики расстояния, такие как евклидово..

    Обеспечение масштабируемости LLM: облачный анализ с помощью AWS Fargate и Copilot
    В динамичной области искусственного интеллекта все большее распространение получают модели больших языков (LLM). Они жизненно важны для различных приложений, таких как интеллектуальные..