Re:Block Comments Are a Bad Idea
by jordanpg on Wednesday October 11, 2017 @08:51AM
(#15449314)
Before starting, I was expecting this piece to be about semantics, not syntax. Something like line comments encouraging concision, where block comments are too large of a canvas.
If I had to distill my criticism about block comments, it would be that my inclination to read someone's multi-line block commented description of the purpose of some variable or loop approaches 0 as number of lines grows past 1, let alone some lengthy TODO blather.
If I had to distill my criticism about block comments, it would be that my inclination to read someone's multi-line block commented description of the purpose of some variable or loop approaches 0 as number of lines grows past 1, let alone some lengthy TODO blather.
I was reminded of some of the Java best practices, eg. http://www.oracle.com/technetwork/java/javase/documentation/....