Commenting code-advise

Hi there,

back in the good old vb days i used to comment code like the following..

Function Name: Test
Use: To provide a test
Inputs : x (string) name of test
Returns: q (int) status of test

And was wondering if anybody has advise on how to comment other aspects of C# i.e. Namespace (is it necessary?), Class, Method, property etrc

Anybody know of a good resource or reading material with suggested ways of commenting code to make it easy understandable i.e. to include i presume inputs and outputs and use??


Who is Participating?
I wear a lot of hats...

"The solutions and answers provided on Experts Exchange have been extremely helpful to me over the last few years. I wear a lot of hats - Developer, Database Administrator, Help Desk, etc., so I know a lot of things but not a lot about one thing. Experts Exchange gives me answers from people who do know a lot about one thing, in a easy to use platform." -Todd S.

You could (perhaps even should) use the xml commenting from C#..

/// <summary>To provide a test.</summary>
/// <param name="x">The name of the test.</param>
/// <returns>The status of the test.</returns>
public int Test(string x)
{return 0;}

If you are using Visual Studio, just type '///' above a class/namespace/method to make the dev env. provide a template for you to fill in!

You can then translate this to documentation using programs like NDoc. The other advantage is that this will also show up in Intellisense, so when you use it it will tell you what the parameters mean etc..



Experts Exchange Solution brought to you by

Your issues matter to us.

Facing a tech roadblock? Get the help and guidance you need from experienced professionals who care. Ask your question anytime, anywhere, with no hassle.

Start your 7-day free trial
ianinspainAuthor Commented:
Cool .. excellent, thats pretty good.. thanks.. assigning points

It's more than this solution.Get answers and train to solve all your tech problems - anytime, anywhere.Try it for free Edge Out The Competitionfor your dream job with proven skills and certifications.Get started today Stand Outas the employee with proven skills.Start learning today for free Move Your Career Forwardwith certification training in the latest technologies.Start your trial today

From novice to tech pro — start learning today.