> Having per-function comment blocks, in contrast, makes sense to have
> inline:
>
> - you read the comment when you read the function
> - you might even update the comment when you update the function
> - you have a reasonable 1:1 relationship.
Personally I'd like to see each C file have a header like
this too, describing in a few lines what the functions in
this file are supposed to do.
This should make it easier for people to figure out not just
what each C file is about, but also if they should spend their
time wading through this particular C file when in search of
some piece of code.
regards,
Rik
-- Shortwave goes a long way: irc.starchat.net #swlhttp://www.surriel.com/ http://distro.conectiva.com/
- 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/