Skip to content

Commit aec65e3

Browse files
authored
Triple slash doc updates (#202)
1 parent eca3435 commit aec65e3

File tree

1 file changed

+5
-3
lines changed

1 file changed

+5
-3
lines changed

prompts/csharp-docs.prompt.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -10,15 +10,17 @@ description: 'Ensure that C# types are documented with XML comments and follow b
1010
- It is encouraged to document internal members as well, especially if they are complex or not self-explanatory.
1111
- Use `<summary>` for method descriptions. This should be a brief overview of what the method does.
1212
- Use `<param>` for method parameters.
13+
- Use `<paramref>` to reference parameters in documentation.
1314
- Use `<returns>` for method return values.
1415
- Use `<remarks>` for additional information, which can include implementation details, usage notes, or any other relevant context.
1516
- Use `<example>` for usage examples on how to use the member.
1617
- Use `<exception>` to document exceptions thrown by methods.
17-
- Use `<see>` and `<seealso>` for references to other types or members.
18+
- Use `<see langword>` for language-specific keywords like `null`, `true`, `false`, `int`, `bool`, etc.
19+
- Use `<see cref>` to reference other types or members inline (in a sentence).
20+
- Use `<seealso>` for standalone (not in a sentence) references to other types or members in the "See also" section of the online docs.
1821
- Use `<inheritdoc/>` to inherit documentation from base classes or interfaces.
1922
- Unless there is major behavior change, in which case you should document the differences.
2023
- Use `<typeparam>` for type parameters in generic types or methods.
2124
- Use `<typeparamref>` to reference type parameters in documentation.
2225
- Use `<c>` for inline code snippets.
23-
- Use `<code>` for code blocks.
24-
- Use `<see langword>` for language specific keywords like `null`, `true`, `false`, `int`, `bool`, etc.
26+
- Use `<code>` for code blocks. `<code>` tags should be placed within an `<example>` tag. Add the language of the code example using the `language` attribute, for example, `<code language="csharp">`.

0 commit comments

Comments
 (0)