[Adium-devl] Early Returns and the Coding Style Docs

Colin Barrett timber at lava.net
Tue Mar 28 18:21:46 UTC 2006


On Mar 28, 2006, at 12:28 PM, Evan Schoenberg wrote:

> but use your judgement for what makes the code easiest for a  
> newcomer to follow.

What's quoted above is possibly the most important thing in this  
thread so far. That's the whole point of our coding style guidelines:  
to make the code easy for a newcomer to follow. This is accomplished  
in several ways: a consistent indentation and bracing style to make  
things visually pleasing, creating a standard for naming so that form  
can then imply function, and discouraging the use of confusing and  
obfuscating coding practices.

Speaking of making the code easier for newcomers to read, is  
documenting the undocumented sections of Adium going to happen, ever?  
I'd like to see it by 1.0, but I dunno how feasible that is. I'm  
willing to lend some time--indirectly by writing better documented  
logging code, and directly by actually documenting undocumented classes.

-Colin




More information about the devel mailing list