-
Notifications
You must be signed in to change notification settings - Fork 26.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
Distinguish doc-comments from other comments #1679
Comments
I'm not sure I understand; what our guide requires is to use |
Look at the example comment.
…On Dec 25, 2017 1:24 PM, "Jordan Harband" ***@***.***> wrote:
I'm not sure I understand; what our guide requires is to use /* */ for
any multiline comment, full stop.
—
You are receiving this because you authored the thread.
Reply to this email directly, view it on GitHub
<#1679 (comment)>,
or mute the thread
<https://github.com/notifications/unsubscribe-auth/AAQtzO44MUeVtb6ZWlafdsjjRErzg1Ciks5tD-h1gaJpZM4RMWFb>
.
|
The first one is marked "bad" (because it uses |
I still don’t understand. Two stars should be used in any and all multiline comment beginnings. |
Then maybe it's something else, let's hear from @erights. Closed the PR. |
I’m also not sure what a “doc-comment” is - do you mean JSDoc? We more or less ban JSDoc entirely; we just haven’t put it in the guide yet, so i wouldn’t want to call them out specifically here. |
Why does your example comment begin with "/**" rather than "/*"? |
The extra |
/*
* make() returns a new element
* based on the passed-in tag name
*/ aligns the |
Then the inner stars are only indented by one space, instead of two. However, i do think i see what you mean - the “good” example doesn’t do this alignment. I’ll clean up this section. |
https://github.com/airbnb/javascript#comments--multiline
recommend
/** ... */
without even mentioning/* ... */
. The former should only be used for doc-comments. The latter should be used for all comments that are not doc-comments, even if they are multiline.The text was updated successfully, but these errors were encountered: