avalon-dev mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From Niclas Hedhman <nic...@hedhman.org>
Subject Re: Studio changes...
Date Sun, 12 Sep 2004 09:05:08 GMT
On Saturday 11 September 2004 21:02, Andreas Oberhack wrote:
> Wow... :-)
>
> Now the code is getting open source .....
>
> Do you need any assistance?

Something like this, I need assistance with at some point sooner or later;
 *  creation/compilation of various "support artifacts", which contains 
references to Artifacts and their versions.
 *  packaging of JARs/ZIPs with 'other' resources.
 *  which cruft is currently not used.
 *  a mail explaining what exists and works and what doesn't.
 *  a list of 'must-haves' for initial release.

I also want to highlight that in OSS, any code is written once but read many, 
many times, so code formatting is of highest importance. This includes not 
only "whitespace management", but is also about "code verbosity". 
So,
while( it.hasNext() )
{
    someMember.getSomething()
        .setAnotherThing( ((File) it.next()).getAbsolutePath() );
}

becomes

while( it.hasNext() )
{
    File someFile = (File) it.next();
    File absolutePath = someFile.getAbsolutePath();
    SomeThing thing = someMember.getSomething();
    thing.setAnotherThing( absolutePath );
}

A smart compiler will collapse the code to make it equally runtime efficient, 
as the handcoded spagetti.

Please keep in mind;
 -  Use 4 spaces, no tabs, for indents.
 -  A space after "(" and before ")" and around all operators.  if( a == b )
 -  braces on new lines
 -  new line between end of one method and beginning of the next method.
 -  not insert a lot of meaningless comments, serving no purpose.
 -  imports are alphabetically sorted with packages and empty line between 
packages.
 -  avoid cascading method access, i.e. not a.getB().getC();
 -  avoid member method access as method argument, i.e. not  setA( b.getC() );


Cheers
Niclas
-- 
   +------//-------------------+
  / http://www.bali.ac        /
 / http://niclas.hedhman.org / 
+------//-------------------+


---------------------------------------------------------------------
To unsubscribe, e-mail: dev-unsubscribe@avalon.apache.org
For additional commands, e-mail: dev-help@avalon.apache.org


Mime
View raw message