On 24/09/14 10:41, Werner LEMBERG wrote:
>> Should I also s?\*?/?g, on the lead-in to the function header
>> comment block, (in addition to introducing each subsequent line with
>> the C++ style '//')?
> 
> Even after reading it twice I'm not exactly sure what you mean :-)
> Please show an example.

Current comment block, (after relocating 'static'), looks like:
> /**********
>  * ps_get_line(): collect an input record from a PostScript file.
>  * ...
>  */
> static
> int ps_get_line(char *buf, ...

Should it rather become:
> //////////
> // ps_get_line(): collect an input record from a PostScript file.
> // ...
> //
> static
> int ps_get_line(char *buf, ...

or:
> //**********
> // ps_get_line(): collect an input record from a PostScript file.
> // ...
> //
> static
> int ps_get_line(char *buf, ...


> Everything else looks fine, thanks.

Thanks.  However, I think I will revise the comment, to clarify the
intent of positive vs. negative return value; if it's not absolutely
clear now, it's sure to cause confusion -- not least for me -- later.

-- 
Regards,
Keith.

Reply via email to