Skip to content

Instantly share code, notes, and snippets.

@aduth
Created August 9, 2018 16:15
Show Gist options
  • Save aduth/f8c8204c818a617cfad5d1dd79bb7441 to your computer and use it in GitHub Desktop.
Save aduth/f8c8204c818a617cfad5d1dd79bb7441 to your computer and use it in GitHub Desktop.
Before:
>Single line comments:
>
>```
>someStatement();
>
>// Explanation of something complex on the next line
>$( 'p' ).doSomething();
>```
>
>Multi-line comments should be used for long comments, see also the [JavaScript Documentation Standards](https://make.wordpress.org/core/handbook/best-practices/inline-documentation-standards/javascript/#multi-line-comments):
>
>```
>/*
> * This is a comment that is long enough to warrant being stretched
> * over the span of multiple lines.
> */
>```
After:
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment