it’s a horrible comment. OTOH it’s world class documentation. obviously i’m not comparing myself, but i often find myself the only one at my $JOB that documents

it’s a horrible comment. OTOH it’s world class documentation. obviously i’m not comparing myself, but i often find myself the only one at my $JOB that documents things at similar level. 99% of the time because i’m touching code i don’t understand and need to understand it first. writing the doco is the way i do it. software would be soooo much better if we lived in a world where a) engineering practice demanded devs document this well, and b) the majority of devs had the skill to write so well. market pressure however demands faster delivery times, and who cares about the tech debt.