Re: [OT?] Coding Style

From: Andrew Morton (andrewm@uow.edu.au)
Date: Tue Jan 23 2001 - 07:52:37 EST


Larry McVoy wrote:
>
> Please don't listen to this. The only place you really want comments is
>
> a) at the top of files, describing the point of the file;
> b) at the top of functions, if the purpose of the function is not obvious;
> c) in line, when the code is not obvious.

One other _very_ useful place: in header files. This is a place where
a comment-per-line is appropriate.

For example, include/linux/fs.h. Shame about `struct inode' though.

-
-
To unsubscribe from this list: send the line "unsubscribe linux-kernel" in
the body of a message to majordomo@vger.kernel.org
Please read the FAQ at http://www.tux.org/lkml/



This archive was generated by hypermail 2b29 : Tue Jan 23 2001 - 21:00:27 EST