From 1b4daa92cb87e277f70acdee286f9ee83b16c63a Mon Sep 17 00:00:00 2001
From: Genevieve Warren <24882762+gewarren@users.noreply.github.com>
Date: Wed, 20 Aug 2025 14:31:09 -0700
Subject: [PATCH] Triple slash doc updates

---
 prompts/csharp-docs.prompt.md | 8 +++++---
 1 file changed, 5 insertions(+), 3 deletions(-)

diff --git a/prompts/csharp-docs.prompt.md b/prompts/csharp-docs.prompt.md
index 43bffa23..2ede7b3d 100644
--- a/prompts/csharp-docs.prompt.md
+++ b/prompts/csharp-docs.prompt.md
@@ -10,15 +10,17 @@ description: 'Ensure that C# types are documented with XML comments and follow b
 - 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 `<paramref>` to reference parameters in documentation.
 - 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 `<see langword>` for language-specific keywords like `null`, `true`, `false`, `int`, `bool`, etc.
+- Use `<see cref>` to reference other types or members inline (in a sentence).
+- Use `<seealso>` for standalone (not in a sentence) references to other types or members in the "See also" section of the online docs.
 - 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.
-- Use `<see langword>` for language specific keywords like `null`, `true`, `false`, `int`, `bool`, etc.
+- 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">`.