Re:`three = 1` in the Linux sourcecode (2014)
by gumby on Tuesday March 09, 2021 @08:14AM
(#26398453)
I agree. The relevant comment is far away.
It’s a local variable so it seems that there would be little impact in renaming it (and the other two). But if the local (kernel in this case) coding conventions discourage variable renaming, a brief comment referring to the later comment would be worthwhile.
Over commenting is a problem, but this would a good use case if renaming is not appropriate.
It’s a local variable so it seems that there would be little impact in renaming it (and the other two). But if the local (kernel in this case) coding conventions discourage variable renaming, a brief comment referring to the later comment would be worthwhile.
Over commenting is a problem, but this would a good use case if renaming is not appropriate.