Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Add link to more info #1080

Merged
merged 1 commit into from
Jan 13, 2025
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
6 changes: 4 additions & 2 deletions Contribute/content/dotnet/api-documentation.md
Original file line number Diff line number Diff line change
Expand Up @@ -87,9 +87,11 @@ If your code example is lengthy, you can put it in a separate file in the docs r
/// </example>
```

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 `<code>` tags are optional, but they cause the code to be formatted correctly/prettily. For example:
Language attributes on `<code>` tags are optional, but they cause the code to be formatted with color coding. For example:

```csharp
/// <example>
Expand Down Expand Up @@ -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)