Messages in this thread | | | Date | Fri, 17 Aug 2007 09:42:04 +0200 | From | Petr Tesarik <> | Subject | Re: Fork Bombing Patch |
| |
-----BEGIN PGP SIGNED MESSAGE----- Hash: SHA1
Paul Jackson wrote: > Petr wrote: >> Please do not add comments inside functions. > > I find this advice a bit odd. I am not aware of > any prohibition of comments inside functions. > > As with comments outside functions, they should > serve a worthwhile purpose, of course. One might > debate whether this particular comment added by > Anand was sufficiently valuable to be worth > having. > > But I don't agree to a blanket prohibition on > comments inside functions.
I'm not saying that comments inside functions should be prohibited, but comments inside functions often lead to over-commenting. There must be a good reason for adding such a comment. See CodingStyle, chapter 8: Commenting:
Also, try to avoid putting comments inside a function body.
(Before somebody starts arguing with this one sentence, please also read the rest of the chapter; it is not long and you'll understand the author's intention better.)
Kind regards, Petr Tesarik -----BEGIN PGP SIGNATURE----- Version: GnuPG v1.4.6 (GNU/Linux) Comment: Using GnuPG with Mozilla - http://enigmail.mozdev.org
iD8DBQFGxVFLjpY2ODFi2ogRAoLUAJwI+cywi9iKHWlx4yora0+WJfCEawCglyrf xyucPIB3W63sbM1dw/Nsv2Y= =SL8f -----END PGP SIGNATURE----- - To unsubscribe from this list: send the line "unsubscribe linux-kernel" in the body of a message to majordomo@vger.kernel.org More majordomo info at http://vger.kernel.org/majordomo-info.html Please read the FAQ at http://www.tux.org/lkml/
| |