Beefy Boxes and Bandwidth Generously Provided by pair Networks
Pathologically Eclectic Rubbish Lister

Re: flower box comments

by vacant (Pilgrim)
on Nov 17, 2003 at 06:34 UTC ( #307578=note: print w/replies, xml ) Need Help??

in reply to flower box comments

Well, sure. It specifies a consistent format, and the format reminds (or requires) the programmer to supply the necessary ingredients for maintainers who will come later. It seems to be missing a Description field, though. I have noticed that without a mandated format, coders will occasionally be lax in documenting functions. Possibly more important than which format is used, is to pick one and everyone follow it consistently. I don't know what your doubts are except, perhaps, that it is too elaborate. Personally, I like it, especially for a formal group project. An editor macro or template file will ease the pain, if you find it painful.

Log In?

What's my password?
Create A New User
Node Status?
node history
Node Type: note [id://307578]
and the web crawler heard nothing...

How do I use this? | Other CB clients
Other Users?
Others meditating upon the Monastery: (7)
As of 2021-02-27 00:03 GMT
Find Nodes?
    Voting Booth?

    No recent polls found