groff
[Top][All Lists]
Advanced

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

Re: [Groff] Multiple Lines Equation


From: Ralph Corderoy
Subject: Re: [Groff] Multiple Lines Equation
Date: Sun, 27 Oct 2013 12:00:01 +0000

Hi Tadziu,

> I remember reading somewhere that comments are unnecessary because the
> code is "obvious":

I think there's an underlying truth here.  I strive to have the code be
obvious through clarity of structure and identifiers that stress their
purpose and would much rather spend time editing to improve that than
add a comment.  Even if sitting there trying to think of a better name
can be hard.  It's a bit like the BUGS section in man pages;  IIRC they
found fixing a shortcoming was less tedious than documenting it.

Non-local type definitions and variables I tend to comment though;
typically how the values are to be interpreted.

>   www.usm.uni-muenchen.de/~hoffmann/roff/tmp/rpdup.pdf

I enjoyed reading that for the first time in quite a few years.

Cheers, Ralph.



reply via email to

[Prev in Thread] Current Thread [Next in Thread]