What order should the documentation be in? Does it belong in the order in which the functions are written, or ordered by another principle, such as frequency of use or function type? Again, the first option is better for the developers, while the second two are better for the user. Should pod be inline (above every function), at the bottom of the module, or in a distinct file? The first is easier for the developers, but the latter two are better for the pod maintainers. There are many things to consider: Location Writing documentation on a project maintained by several people which spans more than one module is a tricky matter. This subroutine returns 1 for success and undef for failure. # A simple pod file named Extra/Additional.pod # # A simple module prepared to use Pod::Template # $ podtmpl -I dir1 -I dir2 documentation.ptmpl $parser->parse( template => 'documentation.ptmpl' )
Pod::Template - Building pod documentation from templates.
0 kommentar(er)
