> I agree that important classes (i.e. 'Node') and exceptional cases > should be documented. But as long as we are mostly developers, my > opinion is that adding fine-grit documentation is something of a waste > of good development time.
I disagree. How much time does it take to write this kind of doc? It takes not much more than writing down the prototype. It should become natural to write the doc when you write the code. It should be just part of the programming, just as you write your comments inside the methods, it's the same. > Unless someone is willing to do it, or willing to pay some one else to > do it, I think all that is needed is to put a little something on every > class and try to document non-obvious things. That would give us much > improvement with relatively little effort. Again, I don't pretend that you guys spend a month in documenting the whole beast, I just try to encourage you to change attitude while developing, get used to put a header right before the method and write a brief comment..... Regards, Toni ------------------------------------------------------------------------- Using Tomcat but need to do more? Need to support web services, security? Get stuff done quickly with pre-integrated technology to make your job easier Download IBM WebSphere Application Server v.1.0.1 based on Apache Geronimo http://sel.as-us.falkag.net/sel?cmd=lnk&kid=120709&bid=263057&dat=121642 _______________________________________________ Opensg-users mailing list [email protected] https://lists.sourceforge.net/lists/listinfo/opensg-users
