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 STYLE_GUIDE.md #1

Merged
merged 2 commits into from
May 8, 2020
Merged

Update STYLE_GUIDE.md #1

Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
46d46e8
Update STYLE_GUIDE.md
schettn May 8, 2020
cc5de23
Update STYLE_GUIDE.md
schettn May 8, 2020
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
18 changes: 16 additions & 2 deletions STYLE_GUIDE.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -40,14 +40,14 @@ let test = "test";
/**
* This is a multiline header comment.
*/

/**
* This is a multiline header comment.
* It has multiple sentences.
*/

/*
* This is a multiline comment.
* This is a multiline comment
*/

/*
Expand All @@ -63,6 +63,20 @@ let test = "test";

// This is a single line comment preffered to use in Javascript.
// It has multiple sentences.

/**
* This is a multiline header comment which contains single line JSDoc tags.
* @description And that's why you should never add dots here
* @description Or here
*/

/**
* This is a multiline header comment which contains multiline JSDoc tags.
* @description And that's why you should
* add dots here.
* @description Or
* here.
*/
```

- Use regions if you have more than 3 distinct areas in your file.
Expand Down