Visual Studio - Summary Tag Comments - Optional Params

c# .net xml visual-studio xml-comments
cweston picture cweston · Sep 7, 2011 · Viewed 11.1k times · Source

When specifying summary tag comments, is there a way with the <param> tag to note that a parameter is optional, ie. the client can supply a value or null, such as: <param name="Mime" optional="true">.

Googling has failed to provide me with a set list of attributes or allowed values. 

/// <summary>
/// Sets data associated with instance
/// </summary>
/// <param name="Key">The key defining the data</param>
/// <param name="Value">The data</param>
/// <param name="Mime">The mime type of the data (optional)</param>     <----- Mark as optional

Thanks

Answer

VMAtm picture VMAtm · Sep 7, 2011

No, you can't. The only attribute being recognized by VS is the name, like that:

<param name="FileName" >The filename of the file to be loaded.</param>

The only thing that you can do - is to set xsl transform for your output document. But this won't have any effect on Intellisense.

Related questions

Read XML Attribute using XmlDocument

How can I read an XML attribute using C#'s XmlDocument? I have an XML file which looks somewhat like this: <?xml version="1.0" encoding="utf-8" ?> <MyConfiguration xmlns="http://tempuri.org/myOwnSchema.xsd" SuperNumber="1" SuperString="whipcream"> <…

Read More
How to read attribute value from XmlNode in C#?

Suppose I have a XmlNode and I want to get the value of an attribute named "Name". How can I do that? XmlTextReader reader = new XmlTextReader(path); XmlDocument doc = new XmlDocument(); XmlNode node = doc.ReadNode(reader); foreach (XmlNode chldNode in …

Read More
Query an XDocument for elements by name at any depth

I have an XDocument object. I want to query for elements with a particular name at any depth using LINQ. When I use Descendants("element_name"), I only get elements that are direct children of the current level. What I'm …

Read More