csharp-docs

Topics in the source

• C# Documentation Best Practices
• Guidance for all APIs
• Methods
• Constructors
• Properties
• Exceptions

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. Use for usage examples on how to use the member. Use for code blocks. tags should be placed within an tag. Add the language of the code example using the language attribute, for example, . Use to reference other types or members inline (in a sentence). Use for standalone (not in a sentence) references to other types or members in the "See also" section of the online docs. Use to inherit documentation from base classes or interfaces. Unless there is major behavior change, in which case you should document the differences. Use to describe method parameters. The description should be a noun phrase that doesn't specify the data type. Begin with an introductory arti

This is an excerpt. Refer to the complete source and its current requirements.