If you can provide a patch for sourcecode to improve or add comments
in a sane way, I am willing to commit those patches. Just please
don't make the mistake to add useless comments.
An useful comment is one that:
-Describes a function algorithm
-Describes what a function does (as
adrian15 <[EMAIL PROTECTED]> writes:
>>> > Please put a comment on each function saying what the function does,
>>> > what sorts of arguments it gets, and what the possible values of
>>> > arguments mean and are used for.
>>> >
>>> > Is it ok that the search.c and test.c (commands/ folder) do not
> Please put a comment on each function saying what the function does,
> what sorts of arguments it gets, and what the possible values of
> arguments mean and are used for.
>
> Is it ok that the search.c and test.c (commands/ folder) do not have any
> of these comments at all?
The currect test.c
adrian15 <[EMAIL PROTECTED]> writes:
> Please put a comment on each function saying what the function does,
> what sorts of arguments it gets, and what the possible values of
> arguments mean and are used for.
>
> Is it ok that the search.c and test.c (commands/ folder) do not have any
> of these
In the GNU Coding Standards they say in:
5.2 Commenting Your Work
Please put a comment on each function saying what the function does,
what sorts of arguments it gets, and what the possible values of
arguments mean and are used for.
Is it ok that the search.c and test.c (commands/ folder) do n