Suggestion: If Forced, Always Write "Why" Comments Over Self-Documented Code #17
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
It might be a good addition on how to write unmaintainable code if one start writing cryptic code and use the comments either by focusing on the "How" (stated in the previous topic) or focusing only in the "Why" and not using the tests, the code itself or the VCS to infer a little bit of the "Why" in order to reduce the number of unnecessary comments.
|
Thanks for your suggestion! Unfortunately I am not accepting new creative content for this article. However, if you read the linked issue, you can see that I'm interested in supporting pull requests like these, just not here. |
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.
It might be a good addition on how to write unmaintainable code if one start writing cryptic code and use the comments either by focusing on the "How" (stated in the previous topic) or focusing only in the "Why" and not using the tests, the code itself or the VCS to infer a little bit of the "Why" in order to reduce the number of unnecessary comments.