Re: [ooc-compiler] Why are parameter comments removed?
Brought to you by:
mva
|
From: August K. <fus...@co...> - 2005-10-11 03:02:17
|
Michael van Acken wrote:
> On 10/10/05, August Karlstrom <fus...@co...> wrote:
>>When generating documentation with oo2c, parameter comments like in e.g.
>>
>> PROCEDURE P(VAR (*in*) a: ARRAY OF LONGINT);
>>
>>are removed. Why?
>
> Mh, I do not understand the question. Documentation, like the output of oob, is
> generated from the symbol file. The compiler discards comments at a very early
> stage, way before the symbol file is generated.
Comments like (*in*) and (*out*) seems to be common practice in ETH
Oberon as a part of the module interface documentation, see e.g.
http://www.oberon.ethz.ch/ethoberon/defs/Strings.Def.html
Just by looking at the procedure signature you know the purpose of VAR.
August
|