Write XML documentation comments for C# types following best practices.
npx skills add https://github.com/viniciuscs84/sdd-toolkit --skill csharp-docs-viniciuscs84
Please help me install this Agent Skill. Skill: csharp-docs Source: https://github.com/viniciuscs84/sdd-toolkit/tree/main/skills/csharp-docs Command: npx skills add https://github.com/viniciuscs84/sdd-toolkit --skill csharp-docs-viniciuscs84
<summary>, <remarks>, <param>, <returns>, <typeparam>, and <exception> tags correctly. - Member-Specific Guidance: Provides wording conventions for methods, constructors, properties, and exceptions, including Boolean and enum phrasing patterns. - Documentation Inheritance: Explains when to use <inheritdoc/> for base classes and interfaces versus writing custom documentation. - Use Case: When adding a new public API to a C# library, apply these rules to generate properly formatted XML doc comments that render correctly in IntelliSense and generated documentation sites. ## Quick Start Review my C# class and add XML documentation comments to all public members following best practices.High-intent search queries and answers about installing and using this skill.
Use triple-slash comments with XML tags above each type or member. Start with a `<summary>` containing a present-tense, third-person verb description, then add `<param>`, `<returns>`, and `<exception>` tags as needed for methods.
Use `<summary>` for the description, `<param>` for each parameter, `<returns>` for the return value, `<typeparam>` for generic parameters, and `<exception cref>` for thrown exceptions. Reference parameters inline with `<paramref>`.
Public members should always be documented with XML comments. Documenting internal members is encouraged, especially when they are complex or not self-explanatory, but it is not strictly required.
Use `<inheritdoc/>` to inherit documentation from base classes or interfaces when behavior matches the base contract. Write custom documentation instead when there is a major behavior change that needs to be described.
For Boolean properties, start the summary with "Gets [or sets] a value that indicates whether...". For Boolean parameters and return values, use the form "`<see langword="true" />` to/if ...; otherwise, `<see langword="false" />`.".
FabienDehopreGenerates standardized XML comments and API documentation for C# code.
albertoiruruetaAudit and complete XML doc comments for .NET/C# classes.
AGIBuildWrite and manage XML documentation comments for .NET code.
apassuelloAutomate adoption of pytest testing patterns across Python codebases.