Can you please explain the following to me?
## _get_commands (nil) : listref
#
# each Machine has its own list of Commands that should be
# executed in response to the user's input. this routine returns
# a reference to that list.
#
What prompted you to do that? What I expect is the following?
=head1 FUNCTIONS ....
=head2 C<_get_commands (nil) : listref>
each Machine has its own list of Commands that should be
executed in response to the user's input. this routine returns
a reference to that list.
=cut
If you're going to bother writing more than two lines of documentation, please make it POD, that is what it is for.
____________________________________________________ ** The Third rule of perl club is a statement of fact: pod is sexy.
-
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.
|