VS2005 - XML Code Documentation
We all know that if you type \\\ on the line above a function or variable definition etc. what you get is:
Code:
///<summary>
///
///</summary>
public void myRidiculouslyLongFunctionNameForNoParticularReason()
{
DoSomeStuff();
}
or maybe
Code:
/// <summary>
///
/// </summary>
/// <param name="iVal"></param>
/// <returns></returns>
public double myLittleMathFunction(int iVal)
{
double rVal = DoSomeMaths();
return rVal;
}
And this is Great.
Does anyone know if it is possible to change/modify/add to the XML Documentation comments that are generated?
Re: VS2005 - XML Code Documentation
This is a list of recommended Xml-Tags you can use inside your applications to document your code.
http://msdn2.microsoft.com/library/5...us,vs.80).aspx
I think there are a couple more, I can post a complete list tomorrow.
Stephan
Re: VS2005 - XML Code Documentation
Quote:
Originally Posted by Sgt-Peppa
Stephan,
Thanks for that. I have to say that I already know what tags can be used, what I am really asking is how do you, or even can you, modify what is inserted automatically when you type /// above a Function/Definition etc.
For example, I want the automatically generated XML comments to include
Code:
///<remarks>
///
///</remarks>
I realise I could type this in manually quite easily, but what you don't realise is that I am incredibly lazy and quite forgetfull, so I want VS2005 to do it for me!
Hope this clarifys my question.
Re: VS2005 - XML Code Documentation
Oh, ok sorry didnt understand you correct there! Sorry have no idea how to do that! Sorry about the misunderstanding!
Re: VS2005 - XML Code Documentation