Two vs document tools

Make a note:

Ghostdoc automatically generates XML comments

When the XML AnnotationSource codeNote text must still be written when the annotation is automatically converted to the RTF help document, which is exhausting many developers. Why not use automation to accelerate the creation of these annotations? This is exactly what ghostdoc 1.9.5 is trying to achieve.

Ghostdoc is a free Visual Studio add-on created by Roland weigelt to help write XML annotations. Once ghostdoc is installed, XML annotations can be generated automatically as long as you use it to refer to annotations and vertices. For example, to add an XML annotation to a method, right-click the method and select the document this option from the context menu. Then, ghostdoc automatically generates XML annotation text based on the type, parameter, name, and other context information of the method.

If you are generating a document for using a type of property or method in. NET Framework, ghostdoc will use a document that Microsoft has compiled for this type. If you use Pascal or camel, ghostdoc splits the name into several words and analyzes these words to generate a document. All the document logic is handled according to the ghostdoc generation rules. You can customize these built-in rules or add new rules. You can also export these rules for use on other computers.

Except for the simplest member, you cannot rely entirely on ghostdoc to write XML comments for you. The comments automatically generated by ghostdoc are only recommended and must be reviewed by developers. In any case, ghostdoc is a compilation plug-in worth a try, which can save a lot of time.

Web: http://www.roland-weigelt.de/ghostdoc

Ndoc

Open-source software that automatically generates help files based on XML annotations does not need to be introduced.

URL: http://ndoc.sourceforge.net/

Because ndoc does not support. NET Framework 1.0 or a later version, it seems useless.

Supports version 2.0, http://community.rainbowportal.net/blogs/jonathans_rainbow_blog/archive/2006/03/21/1685.aspx

Support VS 2005 version: http://sourceforge.net/project/showfiles.php? Group_id = 163095

However, they are all in beta and are not fully functional.

 

ReferenceArticle:

Open source tools and visual maxcompute 2008/. Net 3.5

Generating msdn-style documentation with sandcastle, Nant and cruisecontrol. net