Commenting External Methods

[ConvertFromOldNGs]

by peter fitchett >> Wed, 28 Jun 2000 2:54:44 GMT

Internal methods are easily commented - usually following the method header, before the 'vars', but how many have tried to add some comment
to an external method? You are unable to have a comment following the complete external method header (usually a single line)!

I don't think it is very friendly (let alone readible) to have to insert multiple comment lines into the middle of the external method header.

Thoughts?

[ConvertFromOldNGs]

by Craig Shearer >> Wed, 28 Jun 2000 21:42:00 GMT

Hi Peter

Yes I agree this isn't very friendly, and the same applies to abstract methods, and control event methods (which are just another external method) too. However, a work around is to place a comment before the header - this is legal, and would certainly be better than placing it inside the header.

For example, you can have the following external method definition:

/* This is a test method */
test() is test in somedll;

Regards,
Craig.