Create Naming and Coding Style Conventions #1
Conversation
| ``` | ||
|
|
||
| ### Enumerations | ||
| - Enumeration classes are in |
There was a problem hiding this comment.
Recommend adding a line about how to name the class itself. This only covers the enumerated values.
| - Settings that are essential to your code's functionality (like the number of degrees to turn for `GyroTurn`) can also be passed in | ||
|
|
||
| ### Setting Properties | ||
| - If you need to override a default setting for a class, use the flow model |
There was a problem hiding this comment.
What do you mean by the flow model? I can infer from what it's doing, but I'm not sure this is covered for new developers. Focus on the pattern itself (flow pattern is when the setter method returns this.)
| ``` | ||
|
|
||
| ### Constructors | ||
| - If your class needs to use another classes' object, it should be passed into the constructor |
There was a problem hiding this comment.
Instead of saying that you'll pass the specific classes, refer to them as dependencies. Also if the class implements an interface, the interface should be passed in to decouple from specific implementations.
oconnelc
left a comment
oconnelc
left a comment
There was a problem hiding this comment.
Some cleanup needed but otherwise looks good.
| @@ -0,0 +1,48 @@ | |||
| ### Variables | |||
| - Constants | |||
| - Preceded by `k` | |||
There was a problem hiding this comment.
Add a line about constants being static final members. This is because the fields says "Fields are any variables found in the class body." A new user may get confused as to which naming convention to use.
2 participants
No description provided.