documentation generation - Does Perl have something like Java/PHP Docs? -


does perl have perl docs generator? java docs or php documenter?

yes, it's called perldoc

you write documentation in source, javadoc.

briefly, "=item" bulleted item, e.g. function or parameter "=over" goes down level of identation, "=back" goes level. use "=cut" want switch perl code.

here example of like:

=item $b->add_module ( %options )  initialize module. module repository or branch of repository. valid options  =over  =item id  id of module  =item repo  url of repository. subversion repositories supported.  =back  =cut sub add_module($%) { 

simply pass perl code through perldoc program formatted documentation.


Comments

Popular posts from this blog

c++ - Convert big endian to little endian when reading from a binary file -

C#: Application without a window or taskbar item (background app) that can still use Console.WriteLine() -

unicode - Are email addresses allowed to contain non-alphanumeric characters? -