[Asterisk-Dev] readable code /* New subject */

[Greg Varga]

Just a quick note to point out that www.asteriskdocs.org has the start of a book 
called "Volume Two: Asterisk Internals".

 From the 'Read Asterisk Docs Online' sections:
----------
This is the newest project of The Asterisk Documentation Project, Volume Two: 
Asterisk Internals. Asterisk Internals will discuss the design and 
implementation of the Asterisk Open-Source PBX. This book will cover the back 
end of Asterisk from a coder's perspective, giving the reader an overview of the 
inner-workings of various API's, channels and formats. The document aims to give 
developers new to Asterisk a place to learn how the fundamental parts of 
Asterisk work together.
----------

If anyone would like to help contribute to that project, it would be a great help!

Thanks,
   --Greg

Olle E. Johansson wrote:
> Preston Garrison wrote:
> 
>> You know something that is highly overlooked is learning to write 
>> understandable code.  Alot of programmers like to write code that is a 
>> mess to understand.  Just because you can do something in the C 
>> language doesn't mean you should :)  However i have to admit out of 
>> all the open source projects, asterisk has some of the easiest to 
>> understand code.
>>
> Great. That statements tells me we are heading in the right direction.
> 
> Let's make it better by adding more comments and developer
> documentation. Personally, I've added quite a lot of comments to 
> chan_sip in order to understand it better. Also to other modules as I 
> explore them. Funny part was, some of my comments that was commited to 
> cvs was totally wrong and no one seemed to bother (or propably did not 
> understand the code themselves). So I've changed them as I have learned
> more about the inner workings. :-)
> 
> As I wrote earlier, let's clean up 1.2 and make it easy to understand 
> and easy to work with. Join the asteriskdocs project. Fix errors in
> README files and sample configs. Add comments. Add doxygen documentation.
> 
> You will not get customers to pay for this, but it will make it much 
> easier the next time your customer wants a customization of some kind.
> 
> /Olle
> _______________________________________________
> Asterisk-Dev mailing list
> Asterisk-Dev at lists.digium.com
> http://lists.digium.com/mailman/listinfo/asterisk-dev
> To UNSUBSCRIBE or update options visit:
>   http://lists.digium.com/mailman/listinfo/asterisk-dev
> 
>