in reply to [literate programming] How to mix POD with code? And how to fold this?

Don't. It makes the code hard to read. Perl has a perfectly good # character for putting comments in code.

  • Comment on Re: [literate programming] How to mix POD with code? And how to fold this?

Replies are listed 'Best First'.
Re^2: [literate programming] How to mix POD with code? And how to fold this?
by LanX (Saint) on May 04, 2010 at 22:11 UTC
    > Perl has a perfectly good # character for putting comments in code.

    And how do you create POD compatible documentation from these #-comments?

    Cheers Rolf

[reply]

      You don't. You put the pod at the beginning or the end, where it belongs. Code comments should make sense when you have the code in front of you. If you can make pod from them, they're overwritten, and all they're doing is reducing your ability to see the code by shoving it out of the way. Pod is for a level of documentation that makes sense when you're not staring at the code. It's not dual-sourcing because it's not the same information.

[reply]
        Did I mention folding? Hmm it's even in the title...

        I prefer folding, it's robust and easy compared to the alternative to realize fancy navigation features to jump from code to corresponding POD and vice versa.

        Cheers Rolf

[reply]

In Section Seekers of Perl Wisdom