Beefy Boxes and Bandwidth Generously Provided by pair Networks
Keep It Simple, Stupid

Re^3: Programming *is* much more than "just writing code".

by Mutant (Priest)
on May 09, 2007 at 16:08 UTC ( #614432=note: print w/replies, xml ) Need Help??

in reply to Re^2: Programming *is* much more than "just writing code".
in thread Programming *is* much more than "just writing code".

I think you have some valid points, but there are some issues with having separate module documentation files. Apart from documentation not being directly under the maintainer's nose as I mentioned above, a lot of tools expect the docs to be in the same file as the code, so browsing it becomes an issue.

This could fairly easily be worked around, but on balance, I think it becomes a matter of personal choice, rather than one way being inherently superiour to the other. (There are ways to work around the problems of having it all in one file, such as having a good standard of what the format for each module should be, to keep out-of-place info creeping in).

But I think this is a separate discussion to your original point, which was on the merit of code annotations.
  • Comment on Re^3: Programming *is* much more than "just writing code".

Log In?

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

How do I use this? | Other CB clients
Other Users?
Others browsing the Monastery: (7)
As of 2021-04-14 13:35 GMT
Find Nodes?
    Voting Booth?

    No recent polls found