From mboxrd@z Thu Jan  1 00:00:00 1970
Message-ID: <7744762da5d6e3361b0d1f3af6b3bd45@plan9.bell-labs.com>
Date: Mon, 17 Apr 2006 11:31:42 -0400
From: jmk@plan9.bell-labs.com
To: 9fans@cse.psu.edu
Subject: Re: [9fans] Function args not checked
In-Reply-To: <3e1162e60604170828y1d46b4c6xc77064b88aa5c16@mail.gmail.com>
MIME-Version: 1.0
Content-Type: text/plain; charset="UTF-8"
Content-Transfer-Encoding: quoted-printable
Topicbox-Message-UUID: 37ed96ba-ead1-11e9-9d60-3106f5b1d025

Prototypes are not documentation.

On Mon Apr 17 11:29:34 EDT 2006, leimy2k@gmail.com wrote:
> On 4/17/06, "Nils O. Sel=C3=A5sdal" <noselasd@asgaard.homelinux.org> wr=
ote:
> > 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.
> >
>=20
> 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.
>=20
> Nothing that can't be solved with good comments and man pages though.