Was having a bit of concern due to multi-line comment feature not readily available in perl.

Started to look-out for options and came across this post, and subsequently came to know the various ways we implement the multi-line comment.

Just took one of the options and slightly modified it and have been using it in way like a "defacto" standard in my scripts.

It was nice when i started to use it, and thought would share it.

--- multi-line comment syntax ---

q##//q#
   ... comments ...
   ... comments ...
#;

[download]

--- example ---

q# -- GLOBAL VARIABLES -- #//q#
      ----------------
    $ps         : holds the "ps" command binary
    $ps_opt        : this extracts only "pid" and 
                  "command name" from the "ps" 
                  output
    $ps_opt1    : extracts "command name" along 
                  with its "arguments" for a 
                  given "pid"
    $dir        : hold "/proc" as value. 
                  This is the source directory 
                  from where the search for 
                  required informations for each 
                  pid starts
    $total_swap    : stores the sum of swap usage of 
                  all the individual threads/processes
    @proc_swap    : this array holds the "ref_arrays"
                  in each of its index
    $PROC        : is the file/command handle which
                  holds the information of all the
                  contents within "/proc" directory
#;

[download]

-------------------

Thanks

In reply to Re: Better ways to make multi-line comments in Perl? by bharatt
in thread Better ways to make multi-line comments in Perl? by turumkhan

Title:
Use:  <p> text here (a paragraph) </p>
and:  <code> code here </code>
to format your post, it's "PerlMonks-approved HTML":


  • Posts are HTML formatted. Put <p> </p> tags around your paragraphs. Put <code> </code> tags around your code and data!
  • Titles consisting of a single word are discouraged, and in most cases are disallowed outright.
  • Read Where should I post X? if you're not absolutely sure you're posting in the right place.
  • Please read these before you post! —
  • Posts may use any of the Perl Monks Approved HTML tags:
    a, abbr, b, big, blockquote, br, caption, center, col, colgroup, dd, del, details, div, dl, dt, em, font, h1, h2, h3, h4, h5, h6, hr, i, ins, li, ol, p, pre, readmore, small, span, spoiler, strike, strong, sub, summary, sup, table, tbody, td, tfoot, th, thead, tr, tt, u, ul, wbr
  • You may need to use entities for some characters, as follows. (Exception: Within code tags, you can put the characters literally.)
            For:     Use:
    & &amp;
    < &lt;
    > &gt;
    [ &#91;
    ] &#93;
  • Link using PerlMonks shortcuts! What shortcuts can I use for linking?
  • See Writeup Formatting Tips and other pages linked from there for more info.