Generating C# documentation without building an Xml document [closed]

跟風遠走 提交于 2019-12-14 02:10:08

问题


First of all, I've seen Generating Documentation from C# XML Comments and many others like it, but none of the suggested tools work for what I need.

I need a free tool that can generate documentation (preferably in html) from my source code without using the xml document created by Visual Studio. The project has warnings as errors turned on and checking the option to generate that xml file creates hundreds of errors. In effect, this rules out 90% of c# documentation generators, including Sandcastle, NDoc3, Live Documenter, docu, and ImmDoc.

Doxygen almost works, but I can't seem to get it to generate documentation for overloaded generic classes, such as:

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

MyClass has documentation, but MyClass does not.

So then the question - is there:

  1. a documentation generator I haven't seen that can handle this case,
  2. a config option in one of the tools I've listed that would make it work without requiring the xml-documentation file,
  3. or even a way to turn off just the comment compiler warnings without affecting the build warnings?

Edit. A solution by way of method #3 is to suppress the following warnings relating to xml comments: 1570, 1571, 1572, 1573, 1574, 1580, 1581, 1584, 1587, 1589, 1590, 1591, 1592, 1598, 1710, 1711, 1712, 1723


回答1:


You can disable warning 1591 in Project Properties, then generate the XML.



来源:https://stackoverflow.com/questions/4402333/generating-c-sharp-documentation-without-building-an-xml-document

标签
易学教程内所有资源均来自网络或用户发布的内容,如有违反法律规定的内容欢迎反馈
该文章没有解决你所遇到的问题?点击提问,说说你的问题,让更多的人一起探讨吧!