comment on

I prefer good, well structured, clean, and cohesive code to the best comment any time. Perl, which is, to me, a language that is structured as a spoken language (assuming we would speak in routines, loops and variables), shouldn't (theoretically) be commented more than the obligatory synopsis, the API, and the overall i.e. the "man". If you have to explain anything beyond the overall things, you may need to rethink your code, not your comments.

If your code needs a comment to be understood, it would be better to rewrite it so it's easier to understand. (Notes on Programming in C - Rob Pike)

(Oh, and "hits the argument on the head and drives it right home"?)

Stop saying 'script'. Stop saying 'line-noise'.
We have nothing to lose but our metaphors.

In reply to Re: What is your practice for code documentation? by Erez
in thread What is your practice for code documentation? by ady

Are you posting in the right place? Check out Where do I post X? to know for sure.
Posts may use any of the Perl Monks Approved HTML tags. Currently these include the following:
<code> <a> <b> <big> <blockquote> <br /> <dd> <dl> <dt> <em> <font> <h1> <h2> <h3> <h4> <h5> <h6> <hr /> <i> <li> <nbsp> <ol> <p> <small> <strike> <strong> <sub> <sup> <table> <td> <th> <tr> <tt> <u> <ul>
Snippets of code should be wrapped in <code> tags not <pre> tags. In fact, <pre> tags should generally be avoided. If they must be used, extreme care should be taken to ensure that their contents do not have long lines (<70 chars), in order to prevent horizontal scrolling (and possible janitor intervention).
Want more info? How to link or How to display code and escape characters are good places to start.


Think about Loose Coupling
	PerlMonks