comment on

Much (in a great way) like (similar to) a (singular article) sentence (grouping of words expressing an idea) doesn't (fails to) make (produce) sense (coherent meaning) without (lacking) the (definite article) definition (explanation of meaning) of (preposition) words (grouping of lettings expressing a concept).

Make your reader's life easy by keeping the word definitions as close as possible to the words! It would be crazy to have a separate document that explains the basics and then to expect your copy editor to actually understand the meaning of English words before she jumps in trying to edit your sentences.

Oh, some of my definitions above rather suck. I find that often happens when I'm forced to shift tasks in the middle of composing a sentence and throw together a word definition in order to get the boilerplate in place so I can type in the next word

Touchy (french for bullseye)!

The difference is it isn't like english prose, its more like dictionary


=head2 C<< Much  >>

a definition

=cut

sub Much  {
    "in a great way";
}




=head2 C<<  like  >>

a definition

=cut

sub  like  {
    "similar to";
}




=head2 C<<  a  >>

a definition

=cut

sub  a  {
    "singular article";
}




=head2 C<<  sentence  >>

a definition

=cut

sub  sentence  {
    "grouping of words expressing an idea";
}




=head2 C<<  doesn't  >>

a definition

=cut

sub  doesn't  {
    "fails to";
}




=head2 C<<  make  >>

a definition

=cut

sub  make  {
    "produce";
}




=head2 C<<  sense  >>

a definition

=cut

sub  sense  {
    "coherent meaning";
}




=head2 C<<  without  >>

a definition

=cut

sub  without  {
    "lacking";
}




=head2 C<<  the  >>

a definition

=cut

sub  the  {
    "definite article";
}




=head2 C<<  definition  >>

a definition

=cut

sub  definition  {
    "explanation of meaning";
}




=head2 C<<  of  >>

a definition

=cut

sub  of  {
    "preposition";
}




=head2 C<<  words  >>

a definition

=cut

sub  words  {
    "grouping of lettings expressing a concept";
}
[download]

In reply to Re^3: Documentation: POD vs Comments (proximity is not clarity) by Anonymous Monk
in thread Documentation: POD vs Comments by ravenclaw

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.


go ahead... be a heretic
	PerlMonks