GutoVeronezi commented on pull request #4994:
URL: https://github.com/apache/cloudstack/pull/4994#issuecomment-836841503
@rp- I noticed that you added a lot of comments to the code. Most of they
only describe what the next line is doing, e.q.:
```java
//verify if var is true then print it in console
if (var) {
System.out.println("var is true");
}
```
These types of comments do not improve debugging and goes against a clean
code. However, there are comments that explain a bit of the process, but they
could be resolved with an extraction of the code to a method with a
corresponding name, javadoc and etc.
Also, there are `TODO` comments. These requests should be regularized in
issues, not in code.
Comments should be a last resort, not the rule. If we take all the comments
and sort then in a logic way, we could write a book :smile: .
--
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
For queries about this service, please contact Infrastructure at:
[email protected]
