github/javascript
1
1
Fork 0
mirror of https://github.com/airbnb/javascript.git synced 2026-01-14 11:07:58 -05:00
Code Issues Packages Projects Releases Wiki Activity

[guide] remove subtle endorsement of JSDoc-style commenting.

Browse Source
This commit is contained in:
Jordan Harband
2016-08-31 21:54:51 -07:00
parent 0e4517ea38
commit 3a7210eac1
1 changed files with 2 additions and 5 deletions
Download Patch File Download Diff File Expand all files Collapse all files

7
README.md
View File

@@ -1749,7 +1749,7 @@ Other Style Guides
## Comments
<a name="comments--multiline"></a><a name="17.1"></a>
- [17.1](#comments--multiline) Use `/** ... */` for multi-line comments. Include a description, specify types and values for all parameters and return values.
- [17.1](#comments--multiline) Use `/** ... */` for multi-line comments.
```javascript
// bad
@@ -1768,10 +1768,7 @@ Other Style Guides
// good
/**
* make() returns a new element
* based on the passed in tag name
*
* @param {String} tag
* @return {Element} element
* based on the passed-in tag name
*/
function make(tag) {