Re: AWS Coding Styles (and about boring plain-linear text files in the end)

["Yannick Duchêne (Hibou57)" <yannick_duchene@yahoo.fr>]

Le Mon, 17 Jan 2011 11:23:12 +0100, pascal.obry@gmail.com  
<pascal.obry@gmail.com> a écrit:
>> In “4 Declarations and Types” :
>>
>>     > All local subprograms in a subprogram or package body
>>     > should be declared before the first local subprogram
>>     > body.
>>
>>     Q: Why this requirement of a declaration for body's and
>>        procedure's local subprograms ? Is it to avoid the
>>        need to order subprogram bodies with respect to their
>>        dependencies to each others ? (if so, this would
>>        be contradictory with previous quote).
>
> First this force having a spec and the spec must be commented.
> Second it is better to group all specs together for maintenance
> and code review. You have all local subprograms in a single
> place.
This also force consistency, because without a prior declaration,  
subprograms which are specific to package body comments about the  
signature comes with the subprogram implementation, while comments about  
the signature of subprograms defined in the specification, comes at the  
signature declaration. This lead to inconsistent layout, so it is indeed  
better for this second reason two : comments always comes with  
specification, instead of some with specification and some with  
implementation.

Another third reason, is that this more clearly emphases distinction  
between subprograms specific to package body and the others. Without this,  
if one meet a subprogram implementation, he/she don't know if this  
subprogram in internal or defined in the specification.

About the latter: this makes me recall it happens I feel this may be an  
idea to have a way to clearly mark (a keyword ?) a subprogram  
implementation as being the one of a subprogram declared in a package  
specification or not. This could improve readability, especially when  
defensive programming is a concern. Or… alternatively, smart enough  
editors could automatically tag this, and make this tag clearly visible  
within the UI (ASIS could help).

-- 
Si les chats miaulent et font autant de vocalises bizarres, c’est pas pour  
les chiens.
“ c++; /* this makes c bigger but returns the old value */ ” [Anonymous]