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

Any way to highlight the ES6-specific comments? #19

Open
domenic opened this issue Aug 21, 2013 · 1 comment
Open

Any way to highlight the ES6-specific comments? #19

domenic opened this issue Aug 21, 2013 · 1 comment

Comments

@domenic
Copy link

domenic commented Aug 21, 2013

This might not be something docco is very good at---maybe a post-processing step that works off of some tag (#es6) or something would be better---but it would be cool if the ES6-feature-specific comments were in a different color, or maybe italic, or something. Maybe even a third column O_O. Commenting on the program logic is very different from commenting on the syntax, and I suspect most audiences will be interested in the ES6 syntax (at least for the next few years; once ES6 is commonplace I'm sure people will just be using this as the canonical Todo app reference and ignore all the syntax comments :P)

@addyosmani
Copy link
Member

I'm glad someone else thought this might be a good idea too :) I'd considered whether it would be a good idea to highlight both the ES6-specific comments as well as the ES6-specific lines of code. I don't think docco supports this type of behaviour, but we could use custom annotations + some scripting to:

  • Detect es6-specific comments/code blocks
  • Remove the annotations
  • Highlight

on page load. Will leave this open for discussion as there may be a better way of doing this :)

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

2 participants