It's time for @#$! multiline comments in perl!
Yeah yeah, I know ...
- use 'here docs' (poor option)
- use 'POD' (interferes with docs and no indenting)
- use 'ACME::Comment' (requires module install rights)
- use the 'q' operator (unsuitable for serious use)
q`<!-- ---------------------------
<region-function_docs>
main:
- name : DoFoo
desc : do some foo
usage: DoFoo($optional_greeting);
</region-function_docs>
--------------------------- -->`if(000);
sub DoFoo{
my $optional_greeting = shift || 'Hello World';
print "$optional_greeting\n";
print "we are now doing foo\n";
print "\n";
}###end_sub
So just write your code like that and problem (solved?).
Update: this workaround option parses free of warnings and errors, but is unsuitable for serious use in perl.
-
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.
|