csharpstandard icon indicating copy to clipboard operation
csharpstandard copied to clipboard

Discrepancy in documentation tags descriptions.

Open albert-github opened this issue 3 years ago • 1 comments

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.

albert-github avatar Jul 28 '22 12:07 albert-github

Thanks for noting this @albert-github

I'm going to transfer this issue to the csharpstandard repo for the ECMA committee to take on in its work updating the standard.

BillWagner avatar Jul 28 '22 14:07 BillWagner