Comments on: C# documentation comments: useless?

By: Bennett

Bennett — Tue, 22 Sep 2009 08:20:57 +0000

@geac, thanks for the pointer. I hoped that Sandcastle would eventually become useful — great to see it’s being actively maintained.

By: geac

geac — Mon, 21 Sep 2009 14:03:53 +0000

I found the holy grail: Sandcastle Help File Builder.
http://shfb.codeplex.com/
This tool is outstanding.

By: Carlo

Carlo — Wed, 08 Jul 2009 14:25:15 +0000

Thanks a lot for the post. It save me so much time!!!
great work!!!

By: Matt

Matt — Thu, 19 Mar 2009 15:46:28 +0000

I think you’ve missed one of the best points of the Xml comments which is the tight integration with the IDE.

When you use a Class, Property or Method (from code) it will display the information contained within the Xml comment as a tooltip annotation to help you whilst you code. This is especially useful for method calls, as it will show you the comment for each parameter being passed to the method. This is cool because when a method has been commented correctly you know the purpose of each parameter as you type the code.

This also works when you distribute your code as a DLL, it will retain the comment documentation (unless you tell the compiler not to).

This all makes well doc-commented code super easy to use. The reason the compiler needs to know about the comments is so it can link them to their associated Class/Property/Method. This is not a bad thing, infact it’s super useful.

Matt

By: Andy Dent

Andy Dent — Thu, 05 Mar 2009 07:56:57 +0000

You don’t need to point Doxygen to graphviz provided graphviz binaries are on your path. Yes, it rocks!

By: Randy Fair

Randy Fair — Wed, 28 Jan 2009 01:51:34 +0000

Dude, you rock! Doxygen is major sweet and easy. It takes a little to get the graphs to work; make sure you install graphviz 1st and make sure you point the config file to its path location. Other than that, I dig it.

Thanks again!

By: Thiago

Thiago — Wed, 05 Nov 2008 00:36:35 +0000

Thank you! Best post of the internet!

By: Armel

Armel — Tue, 12 Aug 2008 08:03:08 +0000

Gggggrreeeaatt ppooosstt.. Thank you ssoooo mmmuuucchh.. I am going to give it a try.. do you have other better solutions, because it has been 2 years since your post regarding doxygen ?

By: Marijn

Marijn — Tue, 01 Jul 2008 21:02:42 +0000

Aralmo: Agreed. But Ndoc worked fine with framework 1.0 ( and 1.1 I believe ) but since 2.0 there is no support for it ( for a good personal reason of the owner ).

AA: THATS an option that is built-in. Just go to visual studio and use the option . But I figured that you dont use VS because else you would know that .. right ?

By: AA

AA — Wed, 28 May 2008 13:52:24 +0000

I want to document an XML file.Is there any tool/software available which can document an xml file