views:

393

answers:

1

I am looking for a good example of documentation of an API (coded in C#) where structures are well documented.

Should include:

  • Delegates
  • Events
  • Enums
  • class
  • struct

Right now, I am searching through http://code.google.com, but so far I have not found anything self explanatory.

+1  A: 

Well, if (comments) you are just after code samples - the public API for protobuf-net has a reasonable amount of documentation comments:

It is unusual to write structs, and due to the nature of protobuf-net doesn't use many events - but you get the idea.

These are (of course) shipped in an xml file alongside the dll to provide intellisense. I could run sandcastle against it - I just haven't felt the need.

Marc Gravell
how do you specify author and version? thanks
For the project? AssemblyInfo.cs; for the file? I probably should add a common header - I just haven't. Resharper can help with that. On a change-history basis, IMO the code repository (SVN in this case) owns that data.
Marc Gravell