[kw-pm] javadoc for perl

[Daniel R. Allen]

...except, perhaps, in the non-typical situation where an organization
wants to use a different method, such as javadoc style comments, to be
consistent with their Java code.  I don't think the suggestion was like
'print if /#/' or anything; just a convention for turning regular comments
that were specifically documentation into docs.

Generally, I agree about the use of POD instead of some weird homebrew (or
otherbrew) doc system; I think I directly recommended the standard
"comments for implementation, POD for interface" line.  

The discussion during the talk was between inline POD and EOF POD, and
there was a comment that an alternative to inline POD that looked more
like Javadoc did exist, since some people really don't like inline POD.

-Daniel

On Fri, 22 Nov 2002, Simon Law wrote:

> On Fri, Nov 22, 2002 at 10:34:11AM -0500, Daniel R. Allen wrote:
> > Can the person who suggested that a filter for perl
> > comments-to-documentation that worked like javadoc, provide any more
> > details?
> > 
> > Could it possibly be PolyDoc?
> > http://juggler.ucsd.edu/lab_pages/sigs/polydoc/
> 
> 	You should probably be using POD in the way it was meant to be
> used; directly in the middle of code.  Typically, Perl source files
> aren't incredible huge, and you don't have to document each function for
> it to make sense.
> 
> Simon
> _______________________________________________
> kw-pm mailing list
> kw-pm at mail.pm.org
> http://mail.pm.org/mailman/listinfo/kw-pm
>