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

[Georg Bauhaus <rm-host.bauhaus@maps.futureapps.de>]

On 1/19/11 2:06 AM, Yannick Duchêne (Hibou57) wrote:
> Le Wed, 19 Jan 2011 01:47:33 +0100, Georg Bauhaus <rm-host.bauhaus@maps.futureapps.de> a écrit:

>> The comment specifically mentions the formal argument name,
>> as should be. However, the comment does depend on the name of
>> things.
> So this turn to be a suggestion about the good way to name program elements ?

Following the particular AWS rule, the formal argument name
should be mentioned, but not otherwise matter much.  IIUC.  The
comment then can perhaps be written


    procedure Call (Frmbloo : String);
    --  @{Frmbloo@} is an absolute name of an executable file
    --  to be called


(Regarding the comment markup, I first thought "{{Frmbloo}}";
however, mathematical sets, very useful in comments, can have
sets as elements, "{{" becomes ambigous".  "{{" might be too
similar to "((", too, the latter being valid Ada source text.
The @{ @} construct, sufficiently unique yet simple, can bracket
inline Ada source of any kind; "@@" (or some another pair)
will---if needed---provide for line-wise switching
complementing "--" and eases the writing of coding examples in
comments.  The comments can then be checked by compilers and
tools.

(If programmers didn't suffer from Unicode phobia, the language
designers could pick symbols for bracketing not otherwise used
such as right and left pointing triangles.  Alas, digraphs rule...)