csharp-docs

XML documentation standards and patterns for C# public APIs and members. - Use for one-sentence descriptions starting with a present-tense verb, and for implementation details, usage notes, or additional context - Employ specific tags for different member types: and for methods, for properties, for generics, and for thrown exceptions - Follow prescribed wording patterns for Boolean parameters and return values, enum parameters, and out parameters to ensure consistency across documentation - Use , , , and to create cross-references and reduce duplication across the API surface - Public members should be documented with XML comments. - It is encouraged to document internal members as well, especially if they are complex or not self-explanatory. - Use to provide a brief, one sentence, description of what the type or member does. Start the summary with a present-tense, third-person verb. - Use for additional information, which can include implementation details, usage notes, or any other relevant context. - Use for language-specific keywords like null , true , false , int , bool , etc. - Use for inline code snippets.