6fb794bc79
* Delete outdated development instructions for Next.js + Tailwind and Python; add comprehensive guidelines for PostgreSQL DBA, Angular, ASP.NET REST APIs, Azure Functions with TypeScript, Bicep, Blazor, CMake with vcpkg, C#, .NET MAUI, GenAIScript, Terraform for Azure, localization, and markdown standards. * Update documentation and prompts for consistency and clarity - Standardized description formatting in various markdown files to use single quotes. - Added error handling utility in update-readme.js for safer file operations. - Improved title extraction logic in update-readme.js to handle frontmatter more robustly. - Updated chat modes section in README to reflect new emoji and sorted chat mode links. - Cleaned up various instruction files for better readability and consistency. - Ensured all markdown files end with a newline for better compatibility with version control. * Remove standardize-frontmatter.js script * Add usage instructions for creating and switching chat modes in README.md * Update README.md generation script to enhance instructions and usage details for custom chat modes * Update README.md and update-readme.js for improved instruction clarity and consistency * Refactor README.md links and update readme script for improved clarity and consistency in instructions * Update README.md and update-readme.js for improved instruction clarity and consistency * Changing from a patch to regen approach for the readme * Bit more cleanup for how to show things in the readme * Adding missing description * Another missing description --------- Co-authored-by: Aaron Powell <me@aaron-powell.com>
1.3 KiB
1.3 KiB
| mode | tools | description | ||||
|---|---|---|---|---|---|---|
| agent |
|
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
<summary>for method descriptions. This should be a brief overview of what the method does. - Use
<param>for method parameters. - Use
<returns>for method return values. - Use
<remarks>for additional information, which can include implementation details, usage notes, or any other relevant context. - Use
<example>for usage examples on how to use the member. - Use
<exception>to document exceptions thrown by methods. - Use
<see>and<seealso>for references to other types or members. - Use
<inheritdoc/>to inherit documentation from base classes or interfaces.- Unless there is major behavior change, in which case you should document the differences.
- Use
<typeparam>for type parameters in generic types or methods. - Use
<typeparamref>to reference type parameters in documentation. - Use
<c>for inline code snippets. - Use
<code>for code blocks.