using attributes

[modularbeing]

Im writing a couples classes for a project im working on and I would like to add information for the developer to use when calling the classes like what you seen in the IDE when you select a class from a namespace it shows you how to use that class and tells you what it does. I think I need to use attributes for this but I am having trouble finding information for this exact use. Does anyone know of specific documentation or samples of how to do this?

 

thanks

[mocella]

If you use C#, you can use summary tags. Above each of your functions, just type "///" and it'll fill in the XML tags and you just need to fill in the blanks. Here's what it'll look like:

/// <summary>
/// This function will set the tool-bar and menu-items to the appropriate
/// enabled state based upon the value of isAvailable
/// </summary>
/// <param name="isAvailable">specifies if we want to enable conrols</param>
public void SetUserOptionsAvailable( bool isAvailable )
{
}

 

So now, when someone is trying to use that function, they'll see your explanations in the intellisense.