How to generate comment lines documentation of c# code ?

Question

1.00/5 (1 vote)

See more:

C#

How to generate comment lines documentation of c# code ?
i have the comments in code like following

///

// Function Name : abc
// Description : xyz
///

Posted 5-Jul-12 4:04am

ATM80

Add a Solution

2 solutions

Add a Solution

Add your solution here

Treat my content as plain text, not as HTML

Preview 0

…

Existing Members

Sign in to your account

...or Join us

Download, Vote, Comment, Publish.

Your Email
Password
Forgot your password?

Your Email
This email is in use. Do you need your password?
Optional Password

I have read and agree to the Terms of Service and Privacy Policy
Please subscribe me to the CodeProject newsletters

When answering a question please:

Read the question carefully.
Understand that English isn't everyone's first language so be lenient of bad spelling and grammar.
If a question is poorly phrased then either ask for clarification, ignore it, or edit the question and fix the problem. Insults are not welcome.
Don't tell someone to read the manual. Chances are they have and don't get it. Provide an answer or move on to the next question.

Let's work to help developers, not make them feel stupid.

This content, along with any associated source code and files, is licensed under The Code Project Open License (CPOL)

OriginalGriff · Answer 1 · 2012-07-05T04:38:00

That's a pity, because the easiest way to do it is to use the built in XML comments system...http://msdn.microsoft.com/en-us/magazine/cc302121.aspx[^] - it's an old article, but it gives you the idea.

If you use XML comments (and it's very simple - just start a blank line with "///" above a field, property of method definition and it will do the rest) then you can build documentation from this very easily. And as an extra incentive, the XML comments are transferred into Intelisense as well.

One of the first things I do when I create a new project is to turn on XML enforcement: On the Build tab of the Project Properties, tick the XML Documentation file checkbox. You will then get warnings with each compilation where you haven't documented a method properly. If you also check the "All" radio button under "Treat warnings as errors" on the same tab (as I do) then you can't even run your program unless you have documented it correctly.

Tim Corey · Answer 2 · 2012-07-05T04:33:00

That looks to be a custom type of commenting. There are different third-party addins that can do something similar. It may also be that this is a hand-developed commenting system.

If you are looking for the built-in documentation comments in C#, they would look like this:

C#

/// <summary>
/// 
/// </summary>

You get this by typing the backslash character three times on the line above a method or class (there are a couple other places you can do this as well). The system will auto-generate this list. If you are doing this above a method, it will add parameter lines for each parameter that the method takes as well as a return line for what the method returns (if it doesn't return void).

The benefit of using the XML comments is that they can be picked up by Visual Studio and used by the rest of the system and by automated documentation systems.

How to generate comment lines documentation of c# code ?

2 solutions

Solution 2

Solution 1

Add your solution here

Preview 0