[pdftex] Code comments [was: pdftex compression -- proposed addition to manual]

Tom Kacvinsky tjk at ams.org
Wed Aug 22 10:35:29 CEST 2001

Well, the old UN*X programmers adage is:

  If it was hard to write, damnit, it should be hard to read!

However, whenever I patch pdftex, I try my best to give lucid comments on
what I have done and why.  But I don't alawys succeed.  Part of the problem
is that I hold the opinion that code should be self documenting.  Good
variable names and well ordered structure lead to easy understanding of the
logic, so the comments don't have to be verbose.


On Wed, 22 Aug 2001, Martin Schröder wrote:

> On 2001-08-22 06:05:48 -0700, M. Wroth wrote:
> > I'm firmly in the camp that says literate programming improves the code
> > & saves time in the long run. So my opinion may be biased :-)
> The problem with the pdfTeX sources IMHO is not the lack of literate
> programming but the lack of comments. litprog would be perfect but good
> documentation in the code is a must IMHO.

More information about the pdftex mailing list