Is POD Syntax Obsolete?by qazwart (Scribe)
|on Jun 11, 2013 at 18:10 UTC||Need Help??|
qazwart has asked for the
wisdom of the Perl Monks concerning the following question:
I use POD, and use Pod::Usage through out my code. I am familiar with POD syntax. However, the POD syntax strikes me a bit long in the tooth.
POD syntax was created to help developers to quickly write their code. It is fairly straight forward, but there is a learning curve, and teaching developers to use it can be a pain. I like the concept of POD documentation, but I was thinking that it would be much easier to get developers to write the documentation if we could use Markdown for the syntax;
For example, in POD syntax:
Would be this in Markdown:
Markdown is not only easier to write, but is also more readable. And, developers who use Stackoverflow, GitHub, Reddit, SourceForge, and many other sites would be familiar with its syntax.
I'm not thinking of a wholesale replacement, just a way of using Markdown in POD documentation and have tools like POD::Usage and perldoc to be able to parse it.