[Opensource] for a clean source code

[Michael Rimov]

At 03:55 AM 2/13/2003 +0000, you wrote:
>Lirian Ostrovica wrote:
>>Hi all,
>>Just wanted to express a concern here.
>>It really bothers me to often face left over code throughout the 
>>Expressos source
>>code.
>>In absence of  good or sufficient documentation, you turn to the source 
>>code, and
>>when the source code is misleading
>>it is very bad : you waste your time, you waste the time of the people 
>>who you ask
>>for clarifications, beginners get really confused and frustrated till to 
>>the point
>>of giving up etc etc.
>
>Lirian may you should compare with another open source project e.g tomcat, 
>struts
>or junit to really give a fair code review.
>
>In the new componentization package com.jcorporate.expresso.kernel** has a 
>little
>javadoc comments?

Hi Peter,

Yes, only the base interfaces are well documented at this point in 
time.  They WILL be better documented before the next release.  This 
occurred mainly because I kept wasting my time refactoring APIs as soon as 
I documented them.    As I'm working on the management classes, I've found 
at least one more Interface I have to create... The RootContainer 
interface.  Once things have settled down a bit more, I'll be finishing up 
the API docs.


>There should be a rich set of javadoc for the newest package.
>
>Some of the packages have a lack of javadoc or even comments because Michael
>Nash was the sole developer at the beginning. May be this should on the TODO
>list for Expresso 6.0!

  I think it should be on the task list starting now :)  I keep working on 
improving javadocs with each release.

We also need more unit tests so we can make sure that by removing what we 
think is obsolete code, we don't break anything.  Which is why Lirian keeps 
coming up with weird code issues.

The DBObject unit tests have greatly helped me in this area.  A mock object 
tester for non-http based controllers would also be useful for testing many 
controllers.

                                                 -Mike