Discussion on "Comment Best Practices"

Bruce Wells · 2022-03-03T02:54:08.998Z

How many times have you seen this: /** * @param int $id * @param string $name * @return string */ public function getFileName(int $id, string $name) : string This is a prime example of useless comments, and unfortunately, I see this all the time...

This is an awesome article Bruce. Very important topic.

I use comments very scarcely. Only when I am documenting a method or in case I have an exact reason why I have written a method that way. One big problem with comments that they are usually not following the changes of the code. Instead of comments you should use meaningful variable and method names exatcly as you said. 😊

Thanks! And yes, I forgot to mention "old comments"! Commented out code is also bad. I try to nuke both on sight.

In the end I have decided programming is all about reducing the cognitive load. I will have to write that up as a separate post.

I will definitely read that. 😊Bruce Wells

Discussion

Comment Best Practices

Responses(1)

Recent in Forum

Search Hashnode

Comment Best Practices

Responses(1)

Recent in Forum