POD
POD allows you to create documentation with markup in your Perl code.If you've seen Javadoc or PHPdoc,it's like that.Rather,Javadoc and PHPdoc are like POD.
Except that POD is part of the language,not an add-on spec.
Create headings with =head1 and =head2
Create unordered lists
To create this list:
- Wango
- Tango
Use
- =over
- =item * Wango
- =item * Tango
- =item * Fandango
- =back
- 1 Visit perl101.org
- 2 ???
- 3 Profit!
Use
Use inline markup styles
POD uses B<>, I<> and C<> for bold, italics and , respectively.
- B<This is bolded>
- I<This is italics>
- C<This is code>
Your markup formats can nest.
Link with L<>
The links either to keywords in your document, as in , or to a specific URL, as in .
This came from:
- Everything in a paragraph word-wraps automatically. A paragraph
- is separated by at least one blank line.
- A literal block is indented at least one space
- and does not
- get
POD does not make anything run slower.
It's stripped out at compile time.
TODO
Talk about double-bracketing
Submit a PR to