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

[Proposal]: <placeholder> documentation element #8975

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

[Proposal]: <placeholder> documentation element #8975

DustinCampbell opened this issue Jan 6, 2025 · 0 comments
Assignees
Milestone

Comments

@DustinCampbell
Copy link
Member

Summary

I propose updating the C# language specification to include a mention of a <placeholder> element in documentation. This "inline" element identifies content that is not yet finalized and/or needs further review.

One primary advantage of the <placeholder> element is documentation generation scenarios. Generated documentation content can be placed inside <placeholder> elements to encourage review prior to final acceptance.

🔗 placeholder (Sandcastle MAML Guide)
🔗 SA1651: Do not use placeholder elements (StyleCop Analyzers)

@DustinCampbell DustinCampbell self-assigned this Jan 6, 2025
@dotnet dotnet locked and limited conversation to collaborators 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.
Projects
None yet
Development

No branches or pull requests

1 participant