From 6e85f4de3b81fc4fe5546732e5f98162fc4ce8d2 Mon Sep 17 00:00:00 2001 From: Genevieve Warren <24882762+gewarren@users.noreply.github.com> Date: Wed, 8 Jan 2025 09:57:38 -0800 Subject: [PATCH] Add link to more info --- Contribute/content/dotnet/api-documentation.md | 6 ++++-- 1 file changed, 4 insertions(+), 2 deletions(-) diff --git a/Contribute/content/dotnet/api-documentation.md b/Contribute/content/dotnet/api-documentation.md index 00a3fea0..3ff4aa8d 100644 --- a/Contribute/content/dotnet/api-documentation.md +++ b/Contribute/content/dotnet/api-documentation.md @@ -87,9 +87,11 @@ If your code example is lengthy, you can put it in a separate file in the docs r /// ``` +For some more details about how to hook up separate code files, see [this discussion](https://github.com/dotnet/runtime/pull/111177#discussion_r1907549328). + ## Language attributes -Language attributes on `` tags are optional, but they cause the code to be formatted correctly/prettily. For example: +Language attributes on `` tags are optional, but they cause the code to be formatted with color coding. For example: ```csharp /// @@ -121,4 +123,4 @@ When documenting an API that's not intended to be used by consumers, use wording - [ECMAXML format](http://docs.go-mono.com/index.aspx?link=man%3amdoc(5)) - [Recommended XML tags for C#](/dotnet/csharp/language-reference/xmldoc/recommended-tags) -- [Documentation comments (C# specification)](/dotnet/csharp/language-reference/language-specification/documentation-comments#d2-introduction). +- [Documentation comments (C# specification)](/dotnet/csharp/language-reference/language-specification/documentation-comments#d2-introduction)