diff --git a/prompts/csharp-docs.prompt.md b/prompts/csharp-docs.prompt.md new file mode 100644 index 0000000..6f82916 --- /dev/null +++ b/prompts/csharp-docs.prompt.md @@ -0,0 +1,23 @@ +--- +mode: "agent" +tools: ["changes", "codebase", "editFiles", "problems"] +description: "Ensure that C# types are documented with XML comments and follow best practices for documentation." +--- + +# C# Documentation Best Practices + +- 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 `` for method descriptions. This should be a brief overview of what the method does. +- Use `` for method parameters. +- 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 the member. +- Use `` to document exceptions thrown by methods. +- Use `` and `` for references to other types or members. +- 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.