From: steve@quintile.net (Steve Simon)
Subject: [TUHS] Comments in early Unix systems
Date: Thu, 22 Mar 2018 14:46:13 +0000 [thread overview]
Message-ID: <F86441D1-FB0C-41D9-8519-E31F3238A235@quintile.net> (raw)
In-Reply-To: <20180322012720.GN9739@mcvoy.com>
[-- Warning: decoded text below may be mangled, UTF-8 assumed --]
[-- Attachment #1: Type: text/plain, Size: 1717 bytes --]
> On 22 Mar 2018, at 01:27, Larry McVoy <lm at mcvoy.com> wrote:
>
>> On Wed, Mar 21, 2018 at 07:58:11PM -0500, Andy Kosela wrote:
>> They also state: "Comments are meant to help the reader of a program. They
>> do not help by saying things the code already plainly says, or by
>> contradicting the code, or by distracting the reader with elaborate
>> typographical displays. The best comments aid the understanding of a
>> program by briefly pointing out salient details or by providing a
>> larger-scale view of the proceedings."
>
> I so agree with this. Verbose comments suck. Too many comments suck.
> Why? Because the code evolves and it's work to evolve the comments
> as well. Too many comments means they are not maintained and they
> become incorrect.
>
> I *HATE* comments that are not correct, hate that so much that if you did
> that we would talk, if you kept doing that, you are fired. No comments
> are MUCH better than incorrect comments.
>
> Terseness in comments is good. Comment where it is not obvious what
> is going on. And maintain the comments like you maintain the code.
>
> I agree with Dan (I think) that coding is still a craft and getting the
> comments right is one of the hardest things to master (and I agree that
> Unix did it pretty darn well). No comments suck, too much sucks, just
> right is so darn pleasant.
>
> --lm
on the commenting subject, and as it was Shannon’s anniversary recently... i always felt information theory relates well to comments.
i.e. repeating anything i can see from the code (like “returns void”) tells me nothing.
telling me something non-obvious (“allocate one more for end of list sentinel”) really helps.
-Steve
next prev parent reply other threads:[~2018-03-22 14:46 UTC|newest]
Thread overview: 46+ messages / expand[flat|nested] mbox.gz Atom feed top
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 17:33 ` George Michaelson
2018-03-21 17:50 ` Arthur Krewat
2018-03-21 19:49 ` A. P. Garcia
2018-03-21 19:37 ` Paul Winalski
2018-03-21 17:34 ` Larry McVoy
2018-03-22 2:24 ` Dave Horsfall
2018-03-21 17:39 ` WIlliam Cheswick
2018-03-21 17:52 ` Arthur Krewat
2018-03-21 17:56 ` Nemo
2018-03-21 18:01 ` Larry McVoy
2018-03-21 18:04 ` Dan Cross
2018-03-21 19:56 ` Clem Cole
2018-03-21 20:04 ` [TUHS] comments ( was daemons exorcised ) Earl Baugh
2018-03-21 20:18 ` Paul Winalski
2018-03-21 20:51 ` Ron Natalie
2018-03-21 20:13 ` [TUHS] daemons are not to be exorcised 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 [this message]
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
2018-03-22 1:40 Noel Chiappa
2018-03-22 2:19 ` Steve Nickolas
2018-03-22 13:49 Doug McIlroy
2018-03-22 14:29 ` Nemo
2018-03-23 1:54 Doug McIlroy
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=F86441D1-FB0C-41D9-8519-E31F3238A235@quintile.net \
--to=steve@quintile.net \
/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).