Prototypes are not documentation.

On Mon Apr 17 11:29:34 EDT 2006, [EMAIL PROTECTED] wrote:
> On 4/17/06, "Nils O. SelÄsdal" <[EMAIL PROTECTED]> wrote:
> > [EMAIL PROTECTED] 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.

Reply via email to