Automatically generated documentation.

Question

0.00/5 (No votes)

See more:

Hello all,

I was wondering if there was an equivalent to 'Javadoc' in C# such that I can add an attribute with a description to each of my methods, which can then be automatically generated when development is completed.

I'd prefer the Microsoft standard method or an existing tool in Visual Studio 2008 as opposed to using any third party 'plug-ins'.

Thanks everyone

Laurence.

Posted 31-Jan-11 23:20pm

Laurence1234

Add a Solution

2 solutions

Solution 2

Like this

http://msdn.microsoft.com/en-us/library/aa289191(v=vs.71).aspx[^]

Quick C# Documentation using XML[^]

Posted 31-Jan-11 23:42pm

Manas Bhardwaj

Comments

Manas Bhardwaj 1-Feb-11 5:48am

If you accept it, you should also vote for it. :)

Sergey Alexandrovich Kryukov 1-Feb-11 15:04pm

Manas, I voted "5" to counter-act this stupid idiotic impudent ignorant vote of "3".
I explain why in my comment to Laurence's comment.
Cheers,
--SA

Laurence1234 1-Feb-11 10:22am

Hi,
After trying out some of these solutions I have to say the second link wasn't really suitable. The post was fairly outdated and suggested using a tool which requires a deprecated version of the .NET framework.
Also the first link discuses documentation in relation to VB.NET whereas I was interested in C#.
Sorry.

Sergey Alexandrovich Kryukov 1-Feb-11 15:03pm

Laurence,

Did you vote "3" for this answer? If so, this is plain stupid and impudent! Your question was a general one. The answer is quite adequate, moreover, this matter is a must if the work is done for public.

I'll vote "5"

--SA

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)

Prerak Patel · Accepted Answer · 2011-01-31T23:37:00

Solution 1

SandCastle[^]
NDoc[^]

Posted 31-Jan-11 23:37pm

Prerak Patel

Comments

Pravin Patil, Mumbai 1-Feb-11 5:49am

Very nice links Prerak...

Laurence1234 1-Feb-11 5:50am

Thanks, SandCastle looks like the best bet.
I'll have to write some XSLT afterwards but that should be fine.