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.

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

Update JS style guide with rule for prefixing private class methods with an underscore. #20851

Merged
merged 1 commit into from
Jul 17, 2018
Merged
Changes from all commits
Commits
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
14 changes: 14 additions & 0 deletions style_guides/js_style_guide.md
Original file line number Diff line number Diff line change
Expand Up @@ -215,6 +215,20 @@ class bank_account {}
class bankAccount {}
```

## Prefix private class methods with an underscore

Identifying private class methods makes it easier to differentiate a class's public and internal
APIs, and makes private methods easier to mark as `private` when the code is migrated to TypeScript.

```js
// good
class BankAccount {
addFunds() {}

_calculateInterest() {}
}
```

## Magic numbers/strings

These are numbers (or other values) simply used in line in your code. *Do not
Expand Down