Skip to content
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.

Sign up for GitHub

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

Jump to bottom

Update documentation_style_guide.md with new guideline #6334

Merged
merged 1 commit into from
Aug 9, 2023
Merged

Update documentation_style_guide.md with new guideline #6334

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
39 changes: 25 additions & 14 deletions contributor_docs/documentation_style_guide.md
View file
Open in desktop
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)**
Loading