Last week I wrote about good practices in writing comment headers for source code files. Several readers wrote asking for my thoughts on headers for functions. I recommend reading code. Lots of code.
If you glanced at the title and thought, “I don’t care — I don’t write C code,” then hang on a minute. While it is true that C has a preprocessor and you can notoriously do strange and — depending on ...