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 - are the <code> comments validated? #5780

Open
1 task done
Meir017 opened this issue Sep 19, 2024 · 0 comments
Open
1 task done

Documentation quality - are the <code> comments validated? #5780

Meir017 opened this issue Sep 19, 2024 · 0 comments
Labels
area-engineering-systems untriaged New issue has not been triaged

Comments

@Meir017
Copy link
Contributor

Meir017 commented Sep 19, 2024

Is there an existing issue for this?

  • I have searched the existing issues

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

@joperezr joperezr added the untriaged New issue has not been triaged label Oct 15, 2024
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
area-engineering-systems untriaged New issue has not been triaged
Projects
None yet
Development

No branches or pull requests

3 participants