Re^2: Some clarification where pod files should reside in a distro

Thank you, this is of some help.

Very useful to know putting pod in /* comments */ would do it.
I really appreciate your suggestion about t/, I will implement. Very classy solution.

Personally, putting pod in its own files has helped me maintain the code. It's a little tiny bit more a pain to have more files to keep track of.
I find that having the .pod files draws me to the fact that I have to document.
It helps me keep track of what the API is supposed to do.
I may write a .pod file as an idea and come back later to consolidate reality with plan.

It helps to have both code and doc open next to each other- to go back and forth- yes yes.. I know.. two windows on vi.. Somehow I'm still a mere mortal here.

What are some concrete reasons for which you suggest against the practice mentioned?

Comment on Re^2: Some clarification where pod files should reside in a distro

Replies are listed 'Best First'.
Re^3: Some clarification where pod files should reside in a distro by trwww (Priest) on May 13, 2009 at 21:10 UTC
I didnt really clarify because I guess its something one could go on talking about forever if sufficiently interested. I don't exclusively put POD in modules. I also do like you say. I use POD in the docs/ directory... put it in html comments... all over the place. But for the developer documentation, my rule is that the POD for a given method goes directly above that method. I've developed this convention because I use Catalyst a lot and it generates POD when you make a stub controller. regards,	[reply]

Replies are listed 'Best First'.

Re^3: Some clarification where pod files should reside in a distro
by trwww (Priest) on May 13, 2009 at 21:10 UTC

I didnt really clarify because I guess its something one could go on talking about forever if sufficiently interested.

I don't exclusively put POD in modules. I also do like you say. I use POD in the docs/ directory... put it in html comments... all over the place.

But for the developer documentation, my rule is that the POD for a given method goes directly above that method. I've developed this convention because I use Catalyst a lot and it generates POD when you make a stub controller.

regards,

[reply]