The Unix Heritage Society mailing list
 help / color / mirror / Atom feed
From: doug@cs.dartmouth.edu (Doug McIlroy)
Subject: [TUHS] Comments in early Unix systems
Date: Thu, 22 Mar 2018 09:49:02 -0400	[thread overview]
Message-ID: <201803221349.w2MDn23w100793@tahoe.cs.Dartmouth.EDU> (raw)

"I was told in school (in 1985) that if I was ever lucky enough to
have access to the unix source, I'd find there were no comments. The
reason, I was told at the time, was that comments would make the
source code useful, and selling software was something AT&T couldn't
do due to some consent decree."

I can't speak for SYS V, but no such idea was ever mentioned in
Research circles. Aside from copyright notices, the licensing folks
took no interest in comments. Within rsearch there was tacit
recognition of good coding style--Ken's cut-to-the-bone code was
universally admired. This cultural understanding did not extend
to comments. There was disparagement for the bad, but not honor
for the good. Whatever comments you find in the code were put
there at the author's whim.

My own commenting style is consistent within a project, but
wildly inconsistent across projects, and not well correlated
with my perception of the audience I might be writing for.
Why? I'm still groping for the answer.

For imoortant code, custom is to describe it in a separate
paper, which is of course not maintained in parallel with
the code. In fact, comments are often out of date, too.
Knuth offered the remedy of "literate programming", which
might help in academic circles. In business, probably not.
Yet think of the possibility of a "literate spec", where
the code grows organically with the understanding of what
has to be done.

Doug


             reply	other threads:[~2018-03-22 13:49 UTC|newest]

Thread overview: 29+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2018-03-22 13:49 Doug McIlroy [this message]
2018-03-22 14:29 ` Nemo
2018-03-22 16:30 ` [TUHS] Literate Programming (was Comments in early Unix systems) arnold
2018-03-22 16:48   ` Jon Steinhart
2018-03-22 17:07   ` Toby Thain
  -- strict thread matches above, loose matches on Subject: below --
2018-03-23  1:54 [TUHS] Comments in early Unix systems Doug McIlroy
2018-03-22  1:40 Noel Chiappa
2018-03-22  2:19 ` Steve Nickolas
2018-03-21 14:17 [TUHS] daemons are not to be exorcised Noel Chiappa
2018-03-21 15:03 ` Clem Cole
2018-03-21 16:18   ` Arthur Krewat
2018-03-21 17:28     ` Paul Winalski
2018-03-21 18:04       ` Dan Cross
2018-03-21 19:56         ` Clem Cole
2018-03-21 20:13           ` Paul Winalski
2018-03-21 20:28             ` [TUHS] Comments in early Unix systems Warren Toomey
2018-03-21 20:48               ` Ron Natalie
2018-03-21 22:18               ` William Corcoran
2018-03-21 23:02                 ` Clem Cole
2018-03-22  1:31                   ` Larry McVoy
2018-03-21 23:17                 ` Arthur Krewat
2018-03-21 23:50                   ` Larry McVoy
2018-03-22  0:55                     ` Mike Markowski
2018-03-22  1:00                       ` Larry McVoy
2018-03-21 23:45               ` Warner Losh
2018-03-22  0:31                 ` Steve Johnson
2018-03-22  0:58               ` Andy Kosela
2018-03-22  1:27                 ` Larry McVoy
2018-03-22  1:59                   ` Bakul Shah
2018-03-22 14:46                   ` Steve Simon
2018-03-22 15:22                     ` ron minnich
2018-03-22 16:22                     ` Ron Natalie
2018-03-22 16:32                       ` arnold
2018-03-22 20:20                         ` Lyndon Nerenberg
2018-03-22 16:33                       ` Kurt H Maier
2018-03-23  1:31                   ` Charles Anthony

Reply instructions:

You may reply publicly to this message via plain-text email
using any one of the following methods:

* Save the following mbox file, import it into your mail client,
  and reply-to-all from there: mbox

  Avoid top-posting and favor interleaved quoting:
  https://en.wikipedia.org/wiki/Posting_style#Interleaved_style

* Reply using the --to, --cc, and --in-reply-to
  switches of git-send-email(1):

  git send-email \
    --in-reply-to=201803221349.w2MDn23w100793@tahoe.cs.Dartmouth.EDU \
    --to=doug@cs.dartmouth.edu \
    /path/to/YOUR_REPLY

  https://kernel.org/pub/software/scm/git/docs/git-send-email.html

* If your mail client supports setting the In-Reply-To header
  via mailto: links, try the mailto: link
Be sure your reply has a Subject: header at the top and a blank line before the message body.
This is a public inbox, see mirroring instructions
for how to clone and mirror all data and code used for this inbox;
as well as URLs for NNTP newsgroup(s).