[Asterisk-Dev] Need help to get into the code

[Kevin P. Fleming]

Luigi Rizzo wrote:

> i hope that this is strictly for 'self explanatory' code!!!

It's my personal policy, yes. I cannot speak for everyone, though.

> actually at the very least it would deserve a generic comment
> near the top (perhaps there is a template for this ?)
> 
>  * this is the standard function template, described in <...>
>  * The specific function implemented by this file is described
>  * in the "struct ast_custom_function" that you can find below.

But don't you already know that based on the name/location of the file 
and it's stated purpose (at the top of the file)? Sure, if you take the 
file completely out-of-context then it would be harder to figure out 
what it is doing, but that is not really a useful thing to do :-)

Anyone who thinks the code is under-commented is more than welcome to 
provide what they feel is appropriate commenting in the form of patches...