csharp-docs Skill for Claude: XML Documentation Rules for C#

• Rules for summary, remarks, see, example, code and inheritdoc tags.

  A summary is one sentence that starts with a present-tense, third-person verb. Code examples go in an example tag, with the language set on the code tag. inheritdoc is used unless behavior changes.

  Guidance for all APIs

• How to word param, paramref, typeparam and returns.

  Descriptions are noun phrases that begin with an article and do not name the data type. Booleans, enums and out parameters each get a fixed wording pattern.

  Methods

• The summary reads 'Initializes a new instance of the <Class> class'.

  One fixed sentence for constructors, for a class or a struct.

  Constructors

• Summaries start 'Gets or sets', 'Gets', or 'Gets a value that indicates whether'.

  The value tag describes the value, and a default goes in its own sentence.

  Properties

• Document every exception the member throws directly, with the condition stated plainly.

  For exceptions thrown by nested members, document only the ones users are most likely to hit. Leave off 'Thrown if' at the start of the description.

  Exceptions

Watch out for

• It leads Claude to edit your code files

  SKILL.md holds writing rules only and bundles no scripts. When you ask Claude to apply them, the edits land in your C# source. Use git so you can review or revert them.