Add brief style guidelines. #5
Open
Conversation
This file contains 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
reid-g
reviewed
Apr 10, 2024
| Return values of member functions should be of type `int` and used for error handling. Functions return 0 if no error is encounter, return positive value for warnings and recoverable error, and negative value for irrecoverable errors. | ||
|
|
||
| ### Output | ||
| If an output is needed (for example, a warning needs to be displayed), use `std::cout` and not `printf` as shown below. There should be a space before and after each `<<`. |
There was a problem hiding this comment.
Would there be cases where printf's pretty print would be preferred over std::cout?
| ``` | ||
|
|
||
|
|
||
| ### Member variable naming |
There was a problem hiding this comment.
Will need to add specification that local variables are snake style.
|
|
||
| ```c++ | ||
| constexpr double Pi = 3.1415; // No, it should be all caps | ||
| constexpr double SQRT_TWO = 1.4142 // No, there is an underscore |
There was a problem hiding this comment.
This should be set to valid. So snake-style with all caps. SQRTTWO is hard to read. This would also standard with C library macros
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
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.
This should probably be merged to
develop, but for opportunistic convenience, I suggest we merge it here. Since #1 will likely prompt discussion on new style guidelines, let's direct this PR tocomposer-devbranch.