On Sun, Aug 06, 2000 at 12:20:54AM +0300, Ariel Scolnicov wrote:
> Lisp calls this sort of thing a "documentation string". One nice
Yes. The (dormant) LISP programmer in me winces for not mentioning
that as a reference.
> thing about the Lisp syntax is that it works even if the Lisp doesn't
> support docstrings!
>
> We can also do this. Consider this (upcoming) Perl6 code:
>
> sub foo {
> "Snarf the frobnitzers if x > 0.1";
> my $x = shift;
> # ...
> }
>
> It is perfectly legal Perl5; there is a useless use of a value in void
> context, but that's all.
>
> Another alternative would be Javadoc / doxygen / ... style comments
> (say #@ introduces a comment to be extracted).
Yuk. More magic to remember. Me hate.
I say bring the documentation so close to the thing it documents
that they can see each others' nose hair.
--
$jhi++; # http://www.iki.fi/jhi/
# There is this special biologist word we use for 'stable'.
# It is 'dead'. -- Jack Cohen
