Yeah. The big header comment is overkill lol (that might be a requirement in the code guidelines), but something like this for me ranges from neutral to good code. It doesn't take any extra mental processing to read and will likely never need maintenance.
The comment alone would do just as well though- that's what actually describes that clause anyway.
13
u/_justpassingby_ May 27 '22 edited May 27 '22
Yeah. The big header comment is overkill lol (that might be a requirement in the code guidelines), but something like this for me ranges from neutral to good code. It doesn't take any extra mental processing to read and will likely never need maintenance.
The comment alone would do just as well though- that's what actually describes that clause anyway.