[asterisk-dev] [Code Review] Coding Guidelines, API naming convention, Line length limit

[Russell Bryant]

> On 2009-03-24 10:27:30, Mark Michelson wrote:
> > /trunk/doc/CODING-GUIDELINES, lines 181-184
> > <http://reviewboard.digium.com/r/204/diff/1/?file=3539#file3539line181>
> >
> >     I think that if we are going to institute a column limit for code that we also need to specify some line-splitting guidelines.
> >     
> >     Do we only split lines if they would be in excess of 90 characters?
> >     What tokens do we use as guidelines for splitting lines?
> >     If splitting on an operator, does the operator go at the end of the top line or at the beginning of the bottom line?
> >     What types of lines aren't eligible for splitting?
> 
>  wrote:
>     As another comment, I was just talking with Richard and realized that different people use different-sized tabs, so to one developer, a line may be 90 columns, but to another it may be more or less depending on the indentation level of the line. Does this mean that we need to mandate tab size?

These are excellent comments.  I'll address these and post an updated version when I have a few down minutes.


- Russell


-----------------------------------------------------------
This is an automatically generated e-mail. To reply, visit:
http://reviewboard.digium.com/r/204/#review607
-----------------------------------------------------------


On 2009-03-23 15:19:46, Russell Bryant wrote:
> 
> -----------------------------------------------------------
> This is an automatically generated e-mail. To reply, visit:
> http://reviewboard.digium.com/r/204/
> -----------------------------------------------------------
> 
> (Updated 2009-03-23 15:19:46)
> 
> 
> Review request for Asterisk Developers.
> 
> 
> Summary
> -------
> 
> While doing some code review, I felt that we should more directly address a couple of items in our coding guidelines.
> 
> 1) The coding guidelines has made a reference to line length for a very long time in the example arguments to the indent application.  However, it was not explicitly stated that this is a requirement.  It does now.
> 
> 2) The naming convention used for API calls was not addressed at all.  Proper naming style for API calls is now addressed in the guidelines.
> 
> I do _not_ propose any mass conversion of code that does not conform to these items.  I would simply like to put these guidelines in place for new code, and code being modified already for another reason.
> 
> 
> Diffs
> -----
> 
>   /trunk/doc/CODING-GUIDELINES 183804 
> 
> Diff: http://reviewboard.digium.com/r/204/diff
> 
> 
> Testing
> -------
> 
> N/A.
> 
> 
> Thanks,
> 
> Russell
> 
>