Re: Annotations for Perl

As it happens, the @ notation is used by several code documentation "generators". A somewhat popular one is Doxygen. You might want to look at its notations for the purpose of making your usage compatable.

Also, as I recently discovered, the Perl6 project has extended POD syntax to include similar comments as code annotations, using #| or #= to introduce these annotations. However, the markup in these comments is "just" more POD. However, it validates the concept you are proposing.

There is a module that partially implements Perl6 POD syntax, but it appears to not implement #| and #= comments. If this is the case, I am considering enhancing it.

FWIW, I am working on a Doxygen to POD filter. An early version is Convert Doxygen to POD.

Update: Fixed a grammar error.

Comment on Re: Annotations for Perl Select or Download Code

Replies are listed 'Best First'.
Re^2: Annotations for Perl by hurricup (Pilgrim) on Jun 03, 2015 at 05:47 UTC
If i'm going to use documentation injections, it would be pod with =for i believe, not another documentation system.	[reply]
Re^3: Annotations for Perl by RonW (Parson) on Jun 03, 2015 at 15:46 UTC
I'm just suggesting that if you are going to use @ comments to inject metadata about the source code, it makes sense to do so in a way compatible with document generation tools. That way the generator can re-use the metadata without need to repeat it in your POD markup. BTW, my filter supports `=for` for @ notations while passing other POD markup through, unmodified.	[reply] [d/l]