[Proposal]: <note> documentation element
- Dominant language
- C#
- Stars
- 12.7k
- Forks
- 1.1k
- Avg merge
- 11h 1m
- Merged PRs (30d)
- 3
Description
* Discussion: https://github.com/dotnet/csharplang/discussions/8972
## Summary
[summary]: #summary
I propose updating the C# language specification to define a `` block-level element in the context of XML documentation comments. The `` element has a `type` attribute, which is allowed to be any identifier but the following note types are predefined:
* `note`: A general note. This is the default if the `type` attribute is omitted.
* `implement`: Note to implementers
* `caller`: Note to callers
* `inherit`: Note to inheritors
* `important`: An important note
* `security`: A security note
🔗 [note (Sandcastle XML Comments Guide)](http://ewsoftware.github.io/XMLCommentsGuide/html/4302a60f-e4f4-4b8d-a451-5f453c4ebd46.htm)
Contributor guide
No contributing guide indexed for this repository
Assessment
This issue has not been assessed yet.