[Dev] Coding Guidelines

John Anderson john at osafoundation.org
Wed Nov 17 11:42:59 PST 2004


The reason CPIA uses "sharedWebDAVCollections (self)" and services uses 
"sharedWebDAVCollections(self)" is probably because I wrote CPIA and 
Stuart wrote the services code. I use the extra space, most other people 
don't. I prefer the space because I think it enhances readabliity, 
especially when you get long strings of characters without any spaces, 
e.g. sharedWebDAVCollections(self,parameter1,parameter2,parameter3)

In the past I've preferred strict coding standards which I thought made 
the code more readable.  However as I've gotten older and more 
comfortable with lots of different coding standards I'm less bothered by 
small variations in style -- and, in an open source world it's harder to 
enforce standards and in a commercial setting.

So, although I have a presonal preference on this style issue I think 
it's best to follow the group concensus.

John

Brian Kirsch wrote:

> Hello,
> I've noticed in the CPIA code that many of the methods declarations 
> and calls have a space between the
> method name and the argument list i.e.  def sharedWebDAVCollections 
> (self). I was wondering if there was a specific reason for the space? 
> The Services code uses the traditional methodName() syntax with no 
> space. We should standardize on one form of the other to prevent a 
> coding consistency problem among layers.
>
>
> Brian Kirsch - Email Framework Engineer
> Open Source Applications Foundation
> 543 Howard St. 5th Floor 
> San Francisco, CA 94105 
> (415) 946-3056 
>
>
> _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _ _
>
> Open Source Applications Foundation "Dev" mailing list
> http://lists.osafoundation.org/mailman/listinfo/dev



More information about the Dev mailing list