[Top][All Lists]

[Date Prev][Date Next][Thread Prev][Thread Next][Date Index][Thread Index]

[Bug-gnulib] putting identical comments in both .c and .h files: what do

From: Jim Meyering
Subject: [Bug-gnulib] putting identical comments in both .c and .h files: what do you think?
Date: Sat, 23 Nov 2002 16:37:25 +0100

Hi Bruno,

Thanks for doing that.

I noticed that you and others have duplicated some function
descriptions by also putting a copy in the corresponding .h file.

I don't know about you, but I find it hard to keep
two sets of nominally-identical descriptions in sync.
And I find it annoying to have to make the same change
in two different files -- or risk having them get out of sync.

I suggest that we keep the function descriptions in just one place,
and as near the code it's describing as possible, in the .c file.

However, if someone feels strongly about duplicating those descriptions,
then, IMHO, the least they can do is come up with a way to ensure that the
two copies remain identical.

What do you think?


reply via email to

[Prev in Thread] Current Thread [Next in Thread]