|
in reply to Re: What's your programming style?
in thread What's your programming style?
return $Config{path_sep}
I don't think that's the "separator" the OP's code is looking for.
$Config{path_sep} returns the symbol that separates the pathnames in $ENV{PATH}, but I believe the OP's code is looking for the symbol that separates the individual directories within a pathname.
Cheers,
Rob |
Re^3: What's your programming style?
by Anonymous Monk on Dec 12, 2018 at 21:10 UTC
|
I don't think that's the "separator" the OP's code is looking for.
OP is looking for style, not functionality. Document your subs! | [reply] |
|
|
Agree that POD is a million times better than # Comments. POD inside the sub though is incredibly jarring to me. I don't even like it between subs. I like to wear one hat at a time and code and documentation are polar opposites to my creative flow and focus. I deeply appreciate Perl's flexibility with POD but I personally will always only put POD in the __END__ of packages and scripts. Like a manual for a car, I think the real documents should not even be attached. Comments are a fine substitute for things like # Oil or # + and # - engraved on a part though.
| [reply]
[d/l]
[select] |
|
|
I personally will always only put POD in the __END__ of packages and scripts
Yes.
In a module, I use POD (after __END__) for the user of the module and write comments (with the code) for the maintainer of the module.
That is, I like to keep user and maintainer documentation separate.
See also:
| [reply]
[d/l] |
|
|
POD inside the sub though is incredibly jarring to me.
Amen.
| [reply] |
|
|
Agree that POD is a million times better than # Comments. POD inside the sub though is incredibly jarring to me. I don't even like it between subs. I like to wear one hat at a time and code and documentation are polar opposites to my creative flow and focus.
I agree that embedding POD in subs is somewhat jarring (ugly) and sympathize with the desire to wear one hat at a time (because I too love to code, but hate writing documentation ;). I embed POD in subs to force myself to keep the code and docs in sync. Since they are adjacent to each other this chore becomes very convenient. I used to code first and document later but found it annoying having to decipher non-obvious code all over again resulting in vague documentation. I tend to understand the code perfectly when it's being written and find that to be the perfect time to write accurate documentation. Another benefit to this technique allows one to construct a built-in help system that can display the POD of a specific sub with an option to also dump the code for easy review.
| [reply] |
|
|
|
