dotnet / csharplang

The official repo for the design of the C# programming language
11.61k stars 1.03k forks source link

Proposal: <placeholder> documentation element #1766

Open sharwell opened 6 years ago

sharwell commented 6 years ago

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)

sharwell commented 6 years ago

/cc @EWSoftware