9fans - fans of the OS Plan 9 from Bell Labs
 help / color / mirror / Atom feed
From: Paul Lalonde <plalonde@telus.net>
To: Fans of the OS Plan 9 from Bell Labs <9fans@cse.psu.edu>
Subject: Re: [9fans] Function args not checked
Date: Mon, 17 Apr 2006 08:40:51 -0700	[thread overview]
Message-ID: <00E03F87-8A6C-4DA6-8E7D-1800D4D27157@telus.net> (raw)
In-Reply-To: <7744762da5d6e3361b0d1f3af6b3bd45@plan9.bell-labs.com>

-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1


On 17-Apr-06, at 8:31 AM, jmk@plan9.bell-labs.com wrote:

> Prototypes are not documentation.

Absolutely.  But they have a better chance of reflecting reality.

Not everyone is blessed to work on good code bases.  Until then, I'll  
keep "documenting" my prototypes with good names.

Paul

>
> On Mon Apr 17 11:29:34 EDT 2006, leimy2k@gmail.com wrote:
>> On 4/17/06, "Nils O. Selåsdal" <noselasd@asgaard.homelinux.org>  
>> wrote:
>>> jmk@plan9.bell-labs.com wrote:
>>>> As an aside, when you declare prototypes I find it is best to
>>>> only give the types of the parameters and not declare identifiers,
>>>> e.g.
>>>>       extern Elem mkoid(Ints *); // asn1.h
>>>> rather than
>>>>       extern Elem mkoid(Ints *oid); // asn1.h
>>>> This prevents confusion in environments where there is overuse
>>>> of the pre-processor and the identifier gets substituted.
>>>
>>> Valid point,but I find the names quite helpful and of documentary
>>> value -  perhaps it's a defect of mine after reading too much
>>> non-obvious code.
>>>
>>
>> Well a lot of people fall back to header files for documentation
>> purposes, and looking headers to figure out which of the "char  
>> *'s" is
>> a source and which is a destination in some cases is nice.
>>
>> Nothing that can't be solved with good comments and man pages though.

-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.1 (Darwin)

iD8DBQFEQ7cEpJeHo/Fbu1wRAnhfAKDFwmHNnIaZgveun50Tkqq43OuSBwCgmp6C
+HRZ02LcjezPFri/8RrkuP0=
=eds8
-----END PGP SIGNATURE-----


  reply	other threads:[~2006-04-17 15:40 UTC|newest]

Thread overview: 12+ messages / expand[flat|nested]  mbox.gz  Atom feed  top
2006-04-17  6:50 Rodolfo (kix)
2006-04-17  7:00 ` geoff
2006-04-17  7:25   ` Rodolfo (kix)
2006-04-17 14:52 ` jmk
2006-04-17 15:17   ` "Nils O. Selåsdal"
2006-04-17 15:28     ` David Leimbach
2006-04-17 15:31       ` jmk
2006-04-17 15:40         ` Paul Lalonde [this message]
2006-04-17 16:30           ` Skip Tavakkolian
2006-04-17 20:43             ` Don Bailey
2006-04-17 15:53   ` Victor Nazarov
2006-04-17 16:00     ` Devon H. O'Dell

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=00E03F87-8A6C-4DA6-8E7D-1800D4D27157@telus.net \
    --to=plalonde@telus.net \
    --cc=9fans@cse.psu.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).