in reply to Re: Inline POD vs. EOF POD
in thread Inline POD vs. EOF POD
I use block comments to explain the implementation, and POD to explain the usuage. And IMO, if you use only POD, you either have lousy manual pages, or your code is very lousy documented.On several occasions a monk who we all think highly of, let me know that good code comments itself. If you choose the names of variables and functions carefully, their function in the program becomes clear without separate comments. Comments appear to have the tendency to get out of sink with the code after some reviewing/ debugging rounds. So if you don't need comments at all, your code is better in the long run. I won't claim that I can write such code although I try, and I still feel more comfortable with comments all over the place.
This of course has nothing to do with inline/EOF POD. I see the general case for EOF PODs, but I can think of modules where inline PODs come more natural. If the module only exports a series of reasonable independent functions (so no OO), the interface-PODs can perfectly stay with the exported functions. But even than general usage and example docs are probably better situated EOF.
Jeroen
"We are not alone"(FZ)
|
---|
Replies are listed 'Best First'. | |
---|---|
Re: Commenting, was: Inline POD vs. EOF POD
by Abigail (Deacon) on Jul 10, 2001 at 19:45 UTC | |
by jeroenes (Priest) on Jul 10, 2001 at 20:30 UTC | |
by Abigail (Deacon) on Jul 11, 2001 at 02:43 UTC | |
by jeroenes (Priest) on Jul 11, 2001 at 03:54 UTC | |
by Abigail (Deacon) on Jul 11, 2001 at 14:38 UTC |
In Section
Meditations