I know it is provocative to put complex business logic in plain English to easily explain the logic, or Jira id/bug Id as a future reference in the codebase, but with time, the codebase evolves, methods are refactored but we forgot to refactor comments and your comment will be out of sync and gives a wrong interpretation about the method/code/business logic, undoubtedly a code smell, if you need to put bug id for future reference put as a commit message but avoid comments remember clean code is self-explanatory.
Home
» cleancodetips
» code smell
» design pattern
» java
» Clean code Tips1:: Urge to put comments? refrain to do it.
Clean code Tips1:: Urge to put comments? refrain to do it.
in
cleancodetips,
code smell,
design pattern,
java
- on November 16, 2020
- No comments
Post a Comment