GitHub user torwig added a comment to the discussion: About code comments in
kvrocks
Comments can also improve the understandability of the codebase.
However, I'm a proponent of "right" comments explaining intricate
algorithms/flow/decisions where the descriptive
function/variable/function-parameters names don't help.
Useless, or "bad" comments are like:
```
// Server serves the incoming connections
class Server {...}
// Sets the name of something
// name is a new value for the name
void SetName(const std::string &name);
// Get the number of active connections
size_t GetActiveConnectionsNumber() const;
```
I agree that TODO and FIXME can be helpful (e.g. to find all TODOs in the
project - some IDEs are able to do that).
I think sometimes TODO/FIXME can be converted into a created issue at the
moment a developer decides to put that TODO/FIXME mark into the codebase.
GitHub link:
https://github.com/apache/kvrocks/discussions/1781#discussioncomment-7122352
----
This is an automatically sent email for [email protected].
To unsubscribe, please send an email to: [email protected]
