develooper Front page | perl.perl6.internals | Postings from March 2001

Re: PDD for code comments ????

Thread Previous | Thread Next
From:
Dave Mitchell
Date:
March 26, 2001 05:58
Subject:
Re: PDD for code comments ????
Message ID:
200103261358.OAA17976@gizmo.fdgroup.co.uk
Nick Ing-Simmons <nik@tiuk.ti.com> opined:
> >Either run pod through a pod puller before the C preprocessor gets to
> >the code, or figure out a set of macros that can quote and ignore pod.
> >
> >The second is Yet Another Halting Problem so we go with the first?
> >
> >Which means a little program to depod the source before building it,
> >or a -HASPOD extension to gcc
> >
> >Or just getting in the habit of writing 
> >
> >/*
> >=pod
> >
> >
> >and
> >
> >=cut
> >*/
> 
> Perhaps we could teach pod that /* was alias for =pod
> and */ an alias for =cut ?

or possibly

/*=foo is an alias for =foo,
and */ is an alias for =cut only after a /*= has been encountered.

EG
/*=for apidoc sv_upgrade

Upgrade an SV to a more complex form.  Use C<SvUPGRADE>.  See
C<svtype>.

*/

rather than

/*
=for apidoc sv_upgrade

Upgrade an SV to a more complex form.  Use C<SvUPGRADE>.  See
C<svtype>.

=cut
*/


Thread Previous | Thread Next


nntp.perl.org: Perl Programming lists via nntp and http.
Comments to Ask Bjørn Hansen at ask@perl.org | Group listing | About