dotnet / dotnet/csharpstandard

Discrepancy in documentation tags descriptions.

Open
#602 1 comment 0 reactions 0 assignees View on GitHub
status: needs triaging
Dominant language
C#
Stars
815
Forks
99
Avg merge
1d 14h
Merged PRs (30d)
16

Description

There is a bit of a discrepancy between this chapter "Recommended XML tags for C# documentation comments" (https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/xmldoc/recommended-tags) and the chapter "Annex D Documentation comments" (https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/language-specification/documentation-comments) even when the both chapters might have different intentions.

The discrepancy is that e.g. the tag `permission` is mentioned in the one part and not in the other. Same for `inheritdoc` .

Might be worthwhile to merge both chapters so that the is no duplication / discrepancy.

---
#### Document Details

⚠ *Do not edit this section. It is required for docs.microsoft.com ➟ GitHub issue linking.*

* ID: 3bcb925f-ef72-9a64-3762-c0b4a96f9dc4
* Version Independent ID: d135d0a6-53d2-1567-0b1b-7aae5e07739f
* Content: [Recommended XML documentation tags for a class and its members](https://docs.microsoft.com/en-us/dotnet/csharp/language-reference/xmldoc/recommended-tags)
* Content Source: [docs/csharp/language-reference/xmldoc/recommended-tags.md](https://github.com/dotnet/docs/blob/main/docs/csharp/language-reference/xmldoc/recommended-tags.md)
* Product: **dotnet-csharp**
* Technology: **csharp-language-reference**
* GitHub Login: @BillWagner
* Microsoft Alias: **wiwagn**

Contributor guide

Open the contributing guide

Assessment

This issue has not been assessed yet.

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.