API docs writing guidelines

This Wiki contains the API writing guidelines that we use when creating .NET API documentation. Microsoft employees can also check the reference section of the Microsoft Writing Style Guide.

The following is a list of the sections covered in this Wiki:

• Summary
  • Class
  • Constructor
  • Enum
  • Event-related
  • Field
  • Abstract and virtual member
  • Method
  • Operator
  • Property
  • Overloaded member
• Parameters
  • Methods and constructors
  • On<Event> Methods
  • Dispose(Boolean) Methods
  • Event-handler delegates
  • Operators
• Returns
  • Methods
  • Operators
• Property Value
• Exceptions
• Remarks

If you have suggestions or find any issues with the guidelines proposed here, please file a new issue for the .NET team to evaluate and address.