-
Notifications
You must be signed in to change notification settings - Fork 1.3k
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 highlighting #1475
Comments
I could see this being provided as an additional language; maybe a "language" that enhances existing languages? |
I originally imagined this as an extension of existing languages, but making them into their languages might be better idea. Using this approach we could do it like this: // Prism.languages.java
'doc-comment': {
pattern: /\/\*\*[\s\S]*?\*\//,
greedy: true
},
... Something like |
Yeah, my thought is we could have a single |
My idea is to make a base language Like this, both the user and the language creators have a little more freedom. |
Many languages have an (at least somewhat) standardized syntax for code documentation like JavaDoc, JSDoc , PHPDoc , .Net XML doc (for C#, F# and VB.Net) and others.
Similar to most IDEs, the inline documentation comment should be displayed in a different color than normal comments. Also keywords, type and parameter references, examples and similar should be highlighted.
This means that every the themes will have to be changed to reflect the new syntax highlighting.
I am no designer, so it would be great to get some help.
Because the documentation of many languages is inspired by JavaDoc, it should not be too hard to write an abstract base of doc comment highlighting which is then extended by different languages.
Examples
PrismJS
GitHub
Notepad++
VS Code
The text was updated successfully, but these errors were encountered: