-----BEGIN PGP SIGNED MESSAGE-----
Hash: SHA1
On 17-Apr-06, at 8:31 AM, [EMAIL PROTECTED] 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, [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.
-----BEGIN PGP SIGNATURE-----
Version: GnuPG v1.4.1 (Darwin)
iD8DBQFEQ7cEpJeHo/Fbu1wRAnhfAKDFwmHNnIaZgveun50Tkqq43OuSBwCgmp6C
+HRZ02LcjezPFri/8RrkuP0=
=eds8
-----END PGP SIGNATURE-----
