diff --git a/contributor_docs/documentation_style_guide.md b/contributor_docs/documentation_style_guide.md index ac78c727ad..50d10c4084 100644 --- a/contributor_docs/documentation_style_guide.md +++ b/contributor_docs/documentation_style_guide.md @@ -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)** @@ -1204,4 +1215,4 @@ function preload() { } ``` -**[⬆ back to top](#table-of-contents)** \ No newline at end of file +**[⬆ back to top](#table-of-contents)**