Skip to content

Commit

Permalink
Update documentation_style_guide.md with new guideline
Browse files Browse the repository at this point in the history
Change style guideline for multiline comments to use // reesolving #6332
  • Loading branch information
zelf0 committed Aug 8, 2023
1 parent 069d10c commit 7702839
Showing 1 changed file with 25 additions and 14 deletions.
39 changes: 25 additions & 14 deletions contributor_docs/documentation_style_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -196,24 +196,35 @@ let magicWord = 'Please';
let magicWord = 'Please';
```

- Use `/** ... */` for multiline comments.
- Use `//` for multiline comments.

```javascript
// Bad.
// I will not use // for multiline comments.
// I will not use // for multiline comments.
// I will not use // for multiline comments.
// I will not use // for multiline comments.
// I will not use // for multiline comments.

// Good.
// Bad.
/**
* I will not use // for multiline comments.
* I will not use // for multiline comments.
* I will not use // for multiline comments.
* I will not use // for multiline comments.
* I will not use // for multiline comments.
* I will use // for multiline comments.
* I will use // for multiline comments.
* I will use // for multiline comments.
* I will use // for multiline comments.
* I will use // for multiline comments.
*/

//Bad.
/*
I will use // for multiline comments.
I will use // for multiline comments.
I will use // for multiline comments.
I will use // for multiline comments.
I will use // for multiline comments.
*/

// Good.
// I will use // for multiline comments.
// I will use // for multiline comments.
// I will use // for multiline comments.
// I will use // for multiline comments.
// I will use // for multiline comments.

```

**[⬆ back to top](#table-of-contents)**
Expand Down Expand Up @@ -1204,4 +1215,4 @@ function preload() {
}
```

**[⬆ back to top](#table-of-contents)**
**[⬆ back to top](#table-of-contents)**

0 comments on commit 7702839

Please sign in to comment.