Hi!
>>>>> "MARK" == MARK CALLAGHAN <mdcallag@stripped> writes:
MARK> On Tue, Apr 6, 2010 at 5:56 AM, Michael Widenius <monty@stripped>
> wrote:
>>
>> Hi!
>>>> I know the current rule is liked by some and has upset others, so I
>>>> suggest this be discussed by the Coding style committee (note: I'm not
>>>> in it anymore).
>>
>> However, for someone trying to read or debug the code, having the
>> comments in the header file can be a nightmare.
MARK> Pardon the lousy argument, but the rest of the world disagrees with
MARK> you. Documenting the interface in a header file is a standard
MARK> practice.
What I meant was not to that there would not be any documentation in
the header file;
Of course the purpose of a class and its common members should be
documented.
What I was saying is that I find it even more important that the
comments in the .c/.cc files are complete; Having incomplete comments
in the .cc / .c files and expect that people MUST read the .h files to
understand one implementation is a nightmare.
Regards,
Monty
