Beefy Boxes and Bandwidth Generously Provided by pair Networks
"be consistent"
 
PerlMonks  

Re^6: Comment blocks & private methods (update: indentation)

by LanX (Saint)
on Dec 12, 2014 at 17:15 UTC ( [id://1110195]=note: print w/replies, xml ) Need Help??


in reply to Re^5: Comment blocks & private methods
in thread Comment blocks & private methods

I like the empty =for solution b/c it's concise (only four letters¹) and backwards compatible and you can easily extend it by adding a format.

Though as long as it's not documented some pod-parser might fail if no format is given.

I think Larry might not like them cause /* ... */ might be easily overlooked and therfore people tend to indent the text in between.

> (when you get used to POD containing useless code, you may ignore perfectly useful documentation embeded in the code)

POD is rarely interspersed like in literal programming, and personally I never tend to ignore it more then comments.

Take a look into perl5db.pl as an example.

Cheers Rolf

(addicted to the Perl Programming Language and ☆☆☆☆ :)

¹) With Python needing 3 doublequotes """ this seems a compatative solution.

update

Though POD fails if you need to adjust to surrounding indentation. There is a reason why one should always look up older discussions. ;)

Log In?
Username:
Password:

What's my password?
Create A New User
Domain Nodelet?
Node Status?
node history
Node Type: note [id://1110195]
help
Chatterbox?
and the web crawler heard nothing...

How do I use this?Last hourOther CB clients
Other Users?
Others goofing around in the Monastery: (5)
As of 2024-04-18 06:23 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found