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

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

Мне нужен бесплатный инструмент, который может генерировать документацию (предпочтительно в формате HTML) из моего исходного кода без использования документа XML, созданного Visual Studio. В проекте включены предупреждения об ошибках, и проверка опции для генерации этого XML-файла приводит к сотням ошибок. По сути, это исключает 90% генераторов документации на C#, включая Sandcastle, NDoc3, Live Documenter, document и 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

1 ответ

Решение

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

Другие вопросы по тегам