db-derby-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Jeremy Boynes <jboy...@apache.org>
Subject Re: Class/Method Header in source code
Date Wed, 07 Sep 2005 02:51:07 GMT
Francois Orsini wrote:
> What's the current policy in respect with coding standards in Derby?
> 
> I would like to suggest that there is an extra efforts in commenting source 
> code and in particular class headers which are not there in lots of classes.
> 
> Due to the nature of Open Source, it is not like there are a lot of design 
> documents lying around - providing a description of what a class does (does 
> not have to be a novel) would be benefitial im my opinion (especially for 
> large ones). Class headers make it to javadoc if properly formatted.
> 

Also due to the nature of open source, people are volunteers. Patches 
adding to or otherwise improving documentation would be greatly appreciated.

--
Jeremy

Mime
View raw message