Logo Questions Linux Laravel Mysql Ubuntu Git Menu
 

Are there any conventions for writing POD comments for Perl?

Tags:

perl

perl-pod

I was able to find a page from Safari Books Online that provides a template, but having never written POD comments, I'm not sure how good it is or if it is missing anything that might be considered convention to include.

What are the conventions to follow when writing POD comments for Perl scripts? Is there anything like Sun's Javadoc Conventions, but for POD comments?

like image 410
Thomas Owens Avatar asked Oct 05 '09 14:10

Thomas Owens


2 Answers

It's not elaborate, but I like Juerd's perlpodtut introduction a lot.

The author mentions what he considers common sections and what they would include.

like image 148
Telemachus Avatar answered Oct 21 '22 06:10

Telemachus


There are a set of recommendations in Perl Best Practices. The whole of Chapter 7 covers documentation, using POD, and the best approaches to documentation for modules, large projects etc. It also talks about CPAN conventions. That's probably your best bet.

like image 36
ire_and_curses Avatar answered Oct 21 '22 07:10

ire_and_curses