Road to better programming: Chapter 2. Commenting your code
- Read the previous chapters of The road to better programming.
- Find out more about RCS at the RCS home page.
- Learn more about CVS at the CVS home page.
- Read about folding editors.
- Type "perldoc perlpod" at the command prompt for the perldoc perlpod page.
- Although the Java Code Conventions
pertain to Java, these conventions (especially Chapter 5) are
applicable in spirit to Perl as well. The Javadoc format is very
effective in documenting code for other programmers, but is no
substitute for user documentation. POD is well rounded but lacks API
- Take a look at the CPAN documentation modules of CPAN.org.
- The Lip::Pod module
and Literate Programming concept mix documentation and code freely in a
self-documenting fashion. It has parallels to both POD and Javadoc
- The comp.programming.literate
FAQ, by David B. Thompson, gives a basic description of literate
programming and how the application of literate programming principles
can improve the resulting code. He also presents a list of tools
available to literate programmers.
- Here's some LP propaganda including an overview, examples, cool stuff, and history.
- Visit XEmacs LP mode for some original thoughts and observations on LP as well.
- Find links to all sorts of helpful resources at the literate programming site.
- Read Teodor's other Perl articles in the developerWorks "Cultured Perl" series:
- A programmer's Linux-oriented setup
- Application configuration with Perl
- Automating UNIX system administration with Perl
- Debugging Perl with ease
- The elegance of JAPH
- Genetic algorithms applied with Perl
- One-liners 101
- Parsing with Perl modules
- Perl 5.6 for C and Java programmers
- Reading and writing Excel files with Perl
- Review of Programming Perl, Third Edition
- Small observations about the big picture
- Writing Perl programs that speak English
- Browse more Linux resources on developerWorks.
- Browse more Open source resources on developerWorks.
First published by IBM developerWorks