diff --git a/prompts/csharp-docs.prompt.md b/prompts/csharp-docs.prompt.md index 43bffa2..2ede7b3 100644 --- a/prompts/csharp-docs.prompt.md +++ b/prompts/csharp-docs.prompt.md @@ -10,15 +10,17 @@ description: 'Ensure that C# types are documented with XML comments and follow b - It is encouraged to document internal members as well, especially if they are complex or not self-explanatory. - Use `` for method descriptions. This should be a brief overview of what the method does. - Use `` for method parameters. +- Use `` to reference parameters in documentation. - Use `` for method return values. - Use `` for additional information, which can include implementation details, usage notes, or any other relevant context. - Use `` for usage examples on how to use the member. - Use `` to document exceptions thrown by methods. -- Use `` and `` for references to other types or members. +- Use `` for language-specific keywords like `null`, `true`, `false`, `int`, `bool`, etc. +- 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 `` for type parameters in generic types or methods. - Use `` to reference type parameters in documentation. - Use `` for inline code snippets. -- Use `` for code blocks. -- Use `` for language specific keywords like `null`, `true`, `false`, `int`, `bool`, etc. +- Use `` for code blocks. `` tags should be placed within an `` tag. Add the language of the code example using the `language` attribute, for example, ``.