regarding showing a field/property as required/optional

Dec 4, 2008 at 9:54 PM

I want to know whether there is any tag or feature available to show whether a field/property is required or optional. We are exposing web services to our clients and want to let them know which fields they should be populating for a given service using the sandcastle help file.

Any help will be greatly appreciated.

Dec 4, 2008 at 10:18 PM
Hi Suresh,

I don't believe so, but you can add your own support for a custom tag.  You could also just use the summary or add a note in the remarks, as in the following example.

Gets or sets a name.  This property is required.
<note type="important">
This is a required property.  An exception may be thrown during web service calls if this property is <see langword="null"/> or empty.
public string Name { get; set; }

- Dave