[Contrib: Evaluation System] Evaluation services code

[Jim Eng]

Thanks, Aaron. Good points.  

Also, thanks for the explanation of the desired logic for @override.  Some (if not all) of those were mine. Eclipse now seems to insert that every time it adds a method implementation for a method defined in an interface that is being implemented or in an abstract class that is being extended.  I will remove those annotations if it happens again. 

I also cleaned up some of the comments that were missing or incomplete.  

Jim 


On Jun 21, 2011, at 9:33 AM, Aaron Zeckoski wrote:

> A couple notes to remember on code in the services.
> 
> 1) All methods must be documented. I have marked the methods added in
> the last few months with a TODO which are missing comments to explain
> what they do.
> If you added them (and I think you know who you are) then please go in and
> replace my TODOs with appropriate documentation. I think we should
> reject code which is committed without appropriate commenting and
> tests as a general practice. Otherwise the services code is likely to
> degrade in quality and become unreliable.
> 
> 2) Do not use the @Override annotation on methods when you are not
> overriding an existing method. It is a compiler fail when settings are
> very strict (the level I use) and it is just a bad practice in
> general. This annotation is meant to indicate that the method already
> exists in a class and you are overriding it in the current class. It
> should not be used in any other circumstance.
> I fixed these uses.
> 
> Thanks guys
> -AZ
> 
> 
> -- 
> Aaron Zeckoski - Software Architect - http://tinyurl.com/azprofile
> _______________________________________________
> evaluation mailing list
> evaluation at collab.sakaiproject.org
> http://collab.sakaiproject.org/mailman/listinfo/evaluation
> 
> TO UNSUBSCRIBE: send email to evaluation-unsubscribe at collab.sakaiproject.org with a subject of "unsubscribe"
> 
>