opensg-core  

[Opensg-core] Minimum Comments (Re: [Opensg-commits] ...)

Dirk Reiners
Thu, 03 May 2007 06:46:04 -0700

        Hi Allen,

Allen Bierbaum wrote:
> All of these commits look interesting, but I am having a difficult time 
> figuring out what the various classes and methods are supposed to do 
> since there are no comments.  I know OpenSG doesn't have a policy on 
> this, but what what do you guys think about requesting that all classes 
> should at least have a 1 to 2 sentence description of their purpose?

I think that it's a very good idea to require some minimal comment. 2 
sentences sounds like a good rule of thumb.

        Dirk

-------------------------------------------------------------------------
This SF.net email is sponsored by DB2 Express
Download DB2 Express C - the FREE version of DB2 express and take
control of your XML. No limits. Just data. Click to get it now.
http://sourceforge.net/powerbar/db2/
_______________________________________________
Opensg-core mailing list
Opensg-core@lists.sourceforge.net
https://lists.sourceforge.net/lists/listinfo/opensg-core
  • [Opensg-core] Minimum Comments (Re: [Opensg-commits] ...) Dirk Reiners