Beefy Boxes and Bandwidth Generously Provided by pair Networks
Welcome to the Monastery
 
PerlMonks  

comment on

( #3333=superdoc: print w/replies, xml ) Need Help??
I know that in Java you can place a */ or something similar at the beginning and end of the comments, and then not have to start each new sentence with a star.

The first thing to realize is that you don't have to type a hash at the start of every line. (You used the word "star", but a star is this symbol: "*". A "hash" or a "pound sign" is this symbol: "#". Just so you know... :-) )

Any decent editor (and quite a few bad ones) will let you comment a block without really thinking about it. The trick is, finding an editor that you're used to. I don't really recommend learning vi (it's horrible to learn), but once you know it, things work almost without any concious effort.

For example, using vi, I do this, pretty much by reflex:

  1. type "ma" (mark current line as "a")
  2. hit "i" for insert mode, then type my comment
  3. hit "ESC" (to exit insert mode)
  4. type "mb" (to mark the new line (the end of the comment) as "b")
  5. type ":'a,'bs/^/#/" (from line a to line b, match at the start of line, and substitute in a hash )
  6. type ":'a,'b>" (optional: indent one level, add more > symbols to indent more)

You can do pretty much the same thing in Emacs, or any other editor you like.

Good luck! :-)


In reply to Re: Multi-line comments in perl code? by Anonymous Monk
in thread Multi-line comments in perl code? by mrguy123

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



  • 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 or How to display code and escape characters are good places to start.
Log In?
Username:
Password:

What's my password?
Create A New User
Domain Nodelet?
Chatterbox?
and the web crawler heard nothing...

How do I use this? | Other CB clients
Other Users?
Others chilling in the Monastery: (5)
As of 2022-08-18 14:36 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found

    Notices?