Perl Best Practices (excerpt)---07

The seventh chapter: description document 0 BA.

distinguish between user documentation and technical documentation. 0 ba.

Create standard pod templates for modules and applications. 0 BA Land.

extend and customize your standard pod template. 0 ba Qi.

Place the user description document in the source code file. 0 ba Ba.

Place all user documentation in a separate location in the source code file. 0 BA Nine.

wherever possible, place the pod near the end of the file. 0 ba.

make appropriate refinements to the technical documentation. 0 JIU 0.

The main comment should use a block template. 0 Jiu Yi.

use an entire line of comments to illustrate the algorithm. 0 Nine.

use end-of-line comments to point out subtleties and strange points. 0 Nine.

Make a note of anything that confuses you or is deceived. 0 Nine.

consider whether rewriting is better than making annotations. 0 Jiu Wu.

longer technical discussions to use "invisible" pod passages. 0 Shilu.

Check the spelling, grammar, and soundness of the documentation.

Perl Best Practices (excerpt)---07