add TooManyCommentsViolation

[Khabib73]

Rule request

Thesis

Nowadays, developers often use an excessive number of comments, which leads to unclear code, loss of readability, increased cognitive load, trying replace good documentation.

This rule complements WPS 402..
Let's be honest: people often write comments because their code is less readable and overly complex.

Reasoning

The most appropriate solution is to introduce a new violation called TooManyCommentsViolation.
This violation would enforce a maximum of N comments inside functions or methods (and in the future, we could extend it to all files).

[sobolevn]

Let's do it :)

[Khabib73]

Let's do it :)

@sobolevn
please, assign me :)

[Khabib73]

I also just found out that:

• Comments significantly direct visual attention, accounting for up to 23% of all gaze fixations.
• The effect of comments varies greatly depending on the code fragment. They can either worsen understanding (by 30%) or improve it (by 34%)

Read more in this article.

[Khabib73]

Hi @sobolevn. I'm almost done here! The only thing left is to decide how many comments are allowed?

[Khabib73]

I propose setting the default for TooManyCommentsViolation to 15 comments per function or method. I think that It's not too many and not too few :)

What do you think?

[Khabib73]

btw, AI often adds comments that simply state the obvious, which doesn't add any real meaning :)

[sobolevn]

@Khabib73 this is exactly the point why we need this. We did not need this before the AI, devs are too lazy to write comments.