>>>>> On Mon, 24 May 2010 18:01:49 -0400, Doug Manley <doug.man...@gmail.com> >>>>> said:
DM> Thank you for your time in responding to my question; at our company, DM> we believe in heavily documenting all code before it can be accepted DM> (if that means that people need to work late to get it in, they do DM> ^_^). One of the things that we've found is that what is easy and DM> obvious today is crazy and esoteric tomorrow (especially when it's DM> someone else reading the code). One of the fundamental differences between a company and an open source project is that you can't "mandate" things. The best you can do is "not accept the patch unless it's documented". Unfortunately, in this project it seems that would almost always fall down to "not accept the patch". Commercial companies tend to like to throw us code randomly over their wall but really don't care that it's not documented nor do they care if we accept it much. We end up taking many scraps from companies because the feature is good and worth-while, even if un-or-poorly-documented. I'm actually in the middle of adding lots of comments to a part of the library that has been before-this largely undocumented. We do what we can when we can. DM> I don't mean to criticize anyone in particular; I was hoping that we DM> could collectively make a push for a more coder-friendly source code DM> that newbies can read. I actually think that you'll only find violent agreement here. Everyone I know that has a desire to spend copious amounts of time on the project for the benefit of it (most notably Dave who has likely spent more than anyone else) agrees that both comments and documentation are extremely important. It's making them exist that has traditionally been difficult. (there is, of course, a fine line as was pointed out by someone else... i++; /* increment i by 1 */ is beyond necessary; every situation has two extremes at least to be avoided) -- Wes Hardaker Please mail all replies to net-snmp-coders@lists.sourceforge.net ------------------------------------------------------------------------------ _______________________________________________ Net-snmp-coders mailing list Net-snmp-coders@lists.sourceforge.net https://lists.sourceforge.net/lists/listinfo/net-snmp-coders
