Stories
Slash Boxes
Comments
NOTE: use Perl; is on undef hiatus. You can read content, but you can't post it. More info will be forthcoming forthcomingly.

All the Perl that's Practical to Extract and Report

use Perl Log In

Log In

[ Create a new account ]

jplindstrom (594)

jplindstrom
  (email not shown publicly)

Journal of jplindstrom (594)

Wednesday April 23, 2003
03:19 PM

Strategy, tactics and contracts

[ #11812 ]

Over at Perlmonks, Halley wrote something interesting:

Put strategy in comments, tactics in code

I comment at one (or usually more) levels of abstraction higher than the code.

The language itself determines the need for this. Perl is terse and to the point, requiring few comments if you name things right. Transact-SQL, which I currently use a lot at work, is... uh, not!

Half a line in Perl can often be five or seven lines of SQL. The inflexibility of the language baloons the procedures into endless exercices in page-down. And a comment on top of a seven line statement is a necessary water hole of clarity in this code wilderness.

To Halley's list I would also add:

Put interfaces in POD

POD is also used for more tutorial-like/usage documentation, but it is excellent for carrying the API documentation, to be extracted and presented in some easy-to-browse format. HTML and Perl Oasis comes to mind.

The Fine Print: The following comments are owned by whoever posted them. We are not responsible for them in any way.
 Full
 Abbreviated
 Hidden
More | Login | Reply
Loading... please wait.