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.

Sign up for GitHub

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

Jump to bottom

[Proposal]: <note> documentation element #8973

Open
DustinCampbell opened this issue Jan 6, 2025 · 0 comments
Open

[Proposal]: <note> documentation element #8973

DustinCampbell opened this issue Jan 6, 2025 · 0 comments
Assignees
@DustinCampbell
Labels
Proposal champion
Milestone
Backlog

Comments

@DustinCampbell
Copy link
Member

Summary

I propose updating the C# language specification to define a <note> block-level element in the context of XML documentation comments. The <note> 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)
@dotnet dotnet locked and limited conversation to collaborators Jan 6, 2025
@DustinCampbell DustinCampbell self-assigned this Jan 6, 2025
@DustinCampbell DustinCampbell added this to the Backlog milestone Jan 6, 2025
Sign up for free to subscribe to this conversation on GitHub. Already have an account? Sign in.
Assignees

@DustinCampbell DustinCampbell

Labels
Proposal champion
Projects
None yet
Milestone
Backlog
Development

No branches or pull requests
1 participant
@DustinCampbell