![]() | |||||||||||||
Messages in this thread |
On Maw, 2003-04-15 at 19:02, Eric Altendorf wrote: > If you find yourself having to write comments and documentation to > explain your code, probably your identifiers are not well named, your > functions are not short enough, and your code is not well structured > enough. > > Ideal code is completely self-documenting. We have a lot of elegant small functions that require knowledge of the data structures and lock ordering, which is why I do go around sticking kernel-doc into stuff I touch. Explaining the function is one thing, explaining the context in which it operates is another [IMHO] - 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/ | ||||||||||||
| Last update: 2005-03-22 12:34 [W:0.462 / U:0.140 seconds] ©2003-2008 Jasper Spaans | |||||||||||||