csharp-docs

Use <summary> for a one-sentence description starting with a present-tense third-person verb, <param> for each parameter as a noun phrase, and <returns> for the return value. Add <remarks> for implementation details and <example> with <code> for usage samples.

Write <param> descriptions as noun phrases beginning with an introductory article, without stating the data type. Boolean parameters use "true to ...; otherwise, false", and out parameters start with "When this method returns, contains ...".

Public members should always be documented with XML comments. Documenting internal members is encouraged, especially when they are complex or not self-explanatory, to help future maintainers understand the code.

Use <inheritdoc/> to inherit documentation from base classes or interfaces when the member behaves the same. If there is a major behavior change, document the differences explicitly instead of inheriting.

Use <exception cref> for each exception thrown directly by the member, stating the condition under which it is thrown without phrases like "Thrown if". For nested members, document only exceptions users are most likely to encounter.