chore: add guidance on getters/setters to coding standards #7977
Conversation
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
googlebot
added
the
cla: yes
amcdnl
reviewed
Oct 23, 2017
|
@amcdnl added |
CODING_STANDARDS.md
Outdated
| @@ -167,6 +167,14 @@ be part of the user-facing API. This typically applies to symbols used in templa | |||
| Additionally, the `@docs-private` JsDoc annotation can be used to hide any symbol from the public | |||
| API docs. | |||
|
|
|||
|
|
|||
| #### Getters and Setters | |||
| * Always use a `readonly` property instead of a getter (with no setter) when possible. | |||
There was a problem hiding this comment.
Can you give an example? My brain is struggling to parse the use case
CODING_STANDARDS.md
Outdated
| * Always use a `readonly` property instead of a getter (with no setter) when possible. | ||
| * Avoid long getters and setters. If the logic of an accessor would take more than three lines, | ||
| introduce a new method to contain the logic. | ||
| * A getter should also immediately precede its corresponding setter. |
CODING_STANDARDS.md
Outdated
| * Always use a `readonly` property instead of a getter (with no setter) when possible. | ||
| * Avoid long getters and setters. If the logic of an accessor would take more than three lines, | ||
| introduce a new method to contain the logic. | ||
| * A getter should also immediately precede its corresponding setter. |
There was a problem hiding this comment.
If @Input is on setter, it should come first right? This is saying that getters precede the setter (getters come first)
There was a problem hiding this comment.
Getters come first, @input always goes on the getter.
jelbourn
force-pushed
the
code-guide-setters
branch
from
d1f265d to
88effdb
Compare
Expand with more points
jelbourn
force-pushed
the
code-guide-setters
branch
from
88effdb to
826ffb2
Compare
|
@amcdnl @andrewseguin poke for review |
jelbourn
added
pr: lgtm
action: merge
|
This issue has been automatically locked due to inactivity. Read more about our automatic conversation locking policy. This action has been performed automatically by a bot. |
Sign up for free
to subscribe to this conversation on GitHub.
Already have an account?
Sign in.
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
No description provided.