Join GitHub today
GitHub is home to over 40 million developers working together to host and review code, manage projects, and build software together.
Sign upProposal: allow developers to use write prettier comments #641
Comments
This comment has been minimized.
This comment has been minimized.
If you want a comment to stand out, consider using a block comment: /**
* MY HEADING
*/Inside a block comment, you can do whatever extra formatting you want, for example: /*
* MY HEADING
* ==========
*/ |
feross
closed this
Sep 26, 2016
feross
added
the
question
label
Sep 26, 2016
lock
bot
locked as resolved and limited conversation to collaborators
May 10, 2018
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
crccheck commentedSep 26, 2016
•
edited
(ugh, return in github submits instead of doing a line break, submitted this too early)
Currently, standard does not allow code to have comments like:
The relevant rule with a
--verboseof "Expected space or tab after '//' in comment. (spaced-comment)"I'm not sure why it's not spaced-line-comment but anyways, if you see the docs for spaced-line-comment or spaced-comment, there's a way to make an exception.
Why
/////and not//----or something fancier? Because in VIM, you can copy paste a line, then replace all characters with/to make a fast heading. The uniformity of/also looks better IMHO.Searching the issues shows this hasn't come up for discussion before.