2009/4/21 Doug Manley <[email protected]>:
> I like what you've done, getting the functions grouped nicely at the
> top. It'll provide a much nicer starting point for developers (such
> as myself).
Thanks - that's definitely the idea.
Tidying up the library API (not to mention the library code) is
something that has been bugging me for ages, but I don't often
find the time (and energy) to try and do something about it.
And when I do have the time to work on the project, it tends to be
concentrated on fixing outstanding bugs, rather than documentation,
etc. But since we're in a pre-release chill, this seemed the ideal time
to do a bit tidying up, rather than new work.
> I have a question for the community, however: is there a particular
> reason why there are so few comments in the code
Hmmm...
How about:
- programmer laziness
- lack of time
- laissez-faire management
? :-)
I can't really comment for the other core developers,
but it's probably fair to say that we all tend to be more
interested in functionality rather than documentation.
While I certainly try to comment my code as I go along,
that's more aimed at reminding myself (and other developers)
what the code does - assisting the future maintenance of the
code, rather than providing end-user documentation.
And when it comes to incorporating patches from the tracker system,
I'm unlikely to find the time to go through improving the comments in
these submissions.
I know that's not really good practise - but it's a simple matter of
pragmatism. There is only a limited amount of spare time that I can
find to support this project, and in general that's probably better
spent getting patches and new functionality into the source code,
rather than worrying about the professionalism (or otherwise) of
these submissions.
That's quite apart from the time taken up with the mailing lists,
which can be something of a bottomless pit!
> at least the function prototypes could be well documented
That's certainly what I'm aiming at with this recent work on the
API man pages.
But sure - the internal documentation and comments could
definitely benefit from a proper review. As always, patches
to this end are more than welcome!
Dave
------------------------------------------------------------------------------
Stay on top of everything new and different, both inside and
around Java (TM) technology - register by April 22, and save
$200 on the JavaOne (SM) conference, June 2-5, 2009, San Francisco.
300 plus technical and hands-on sessions. Register today.
Use priority code J9JMT32. http://p.sf.net/sfu/p
_______________________________________________
Net-snmp-coders mailing list
[email protected]
https://lists.sourceforge.net/lists/listinfo/net-snmp-coders
