Ville Laurikari, in an older post that recently made the Hacker News front page, talks about the evils of source-code templates:
Most projects have some kind of standard source code template which has the copyright and license text and placeholders for things like a description. All I have to say is: You don’t need a template. Stop using it.
He’s referring to things like this, found at the top of most source-code files:
1 2 3 4 5 | /* * File: filename.c * Author: Peter J. Vidler * Copyright (c) 2010. All rights reserved. */ |
Actually, that one’s fairly trivial — see the actual post for a much worse example. His post actually seems to be about file-level comments, rather than comment templates, but it’s still worth a read.
Tags: C++, Code Generation, Software