API documentation

The key words “MUST”, “MUST NOT”, “REQUIRED”, “SHALL”, “SHALL NOT”, “SHOULD”, “SHOULD NOT”, “RECOMMENDED”, “MAY”, and “OPTIONAL” in this document are to be interpreted as described in RFC 2119.

All public APIs MUST be documented regardless of what language and use-case.

C# XML Comments

All C# files MUST be documented using the XML documentation as defined here. A tutorial can also be found here.

For inheritance in documentation, you can use the <inheritdoc/>.


All JavaScript files MUST be documented using JSDoc as defined here