Paul Speranza's .Net Life

Life with .Net

Commenting enums

Can anyone tell the proper coding convention for xml comments for an enum in C#?
Posted: Jul 27 2004, 09:14 AM by Paul Speranza | with 2 comment(s)

Comments

Michael Hodnick said:

On my team, we add a Summary and optional Remarks to the Enum and also to each constant within the Enum. As for wording within the Summary or Remarks, we don't have a convention.
# July 27, 2004 9:25 AM

Howard van Rooijen said:

I generally add a summary tag to the enumeration, and a summary tag to each sub-item – you can see an example here:

http://www.1succeeded0failed0skipped.com/PermaLink.aspx?guid=17407214-7174-4454-9c6e-48688b672ab7
# July 27, 2004 10:46 AM
Leave a Comment

(required) 

(required) 

(optional)

(required)