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

comment on

( [id://3333]=superdoc: print w/replies, xml ) Need Help??

I'm new to Perl and am trying to figure out how to use POD.

First, some important "stuff": OS: Windows 7 on my desktop and Ubuntu 1204 on my laptop (I use both somewhat interchangeably). Perl: Strawberry 5.18 on Windows, 5.14 on Linux. IDE: Padre and Eclipse/Epic (both loaded on each platform, and I alternate between them).

I've created just a tiny POD sample:

#!/usr/bin/perl print "Hello, World!\n"; =head1 NAME My::Module - An example module =cut

When I run the program, "Hello, World!" prints properly; the POD stuff is ignored (as I expect). However, how can I view the documentation?

I've tried running perldoc in a terminal with the name of the script as an argument: perldoc hello.pl -- but that doesn't seem to work.

I created a separate .POD file with some documentation and this did work: perldoc hello.pod. However, is there some way to view the documentation that's embedded in a script? Ideally, I'd like to embed the POD documentation at the bottom of a script and then click something or enter something to view that documentation from within either IDE.

Thanks, in advance, for any help you can offer.


In reply to How To View POD Embedded in a Perl Script? by ParsonGeorge

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 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?Last hourOther CB clients
Other Users?
Others musing on the Monastery: (3)
As of 2024-03-28 13:13 GMT
Sections?
Information?
Find Nodes?
Leftovers?
    Voting Booth?

    No recent polls found