开发者

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

Closed. This question does not meet Stack Overflow guidelines. It is not currently accepting answers.

We don’t allow questions seeking recommendations for books, tools, software libraries, and more. You can edit the question so it can be answered with facts and citations.

开发者_运维问答

Closed 5 years ago.

Improve this question

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


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

0

上一篇:

下一篇:

精彩评论

暂无评论...
验证码 换一张
取 消

最新问答

问答排行榜