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

Documentation quality - validating <code> documentation comments #7545

Open
Meir017 opened this issue Jan 24, 2025 · 0 comments
Open

Documentation quality - validating <code> documentation comments #7545

Meir017 opened this issue Jan 24, 2025 · 0 comments

Comments

@Meir017
Copy link

Meir017 commented Jan 24, 2025

Is your feature request related to a problem? Please describe the problem.

There is no enforcement on the validity of the <code> xml comment tags

Describe the solution you'd like

We should be able to have a small console-application that parses uses the roslyn-api each of the apire projects and extract the <code> comments and validates they are valid C# syntax and that the snippet is a valid C# program (adding a reference to relevant projects).

Additional context

playwright does something like this and validate their C# comment are valid syntax https://github.com/microsoft/playwright/blob/main/utils/doclint/linting-code-snippets/csharp/Program.cs

originally created at dotnet/aspire#5780

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
None yet
Projects
None yet
Development

No branches or pull requests

1 participant