PHP/C/C++ - How does your initial comment block look in your programs?

Question

I am on a large project, and have not really made any comment 'headers' in my program yet. I just started using SVN for the project the other day. I want to add the SVN tag $id$, but have not decided on any standard commenting.

So, my question to everyone here, is how does your initial comment block look in all your programs?

i.e:

/***************************************
* myProgram.c 
* revision: $id$
***************************************/

Answer 1

I don't use one. I don't need one.

Answer 2

Company boilerplate copyright + file author/owner and a small purpose section when relevant (eg: when the file contains a collection of small related classes with headers of their own)

Answer 3

If I'm coding some open-source program I usually add a BSD license, otherwise there's no standard header comment.

Answer 4

It depends, but I don't like if they are too fancy. Something like this is enough for me:

/*
 * file.c
 *
 * Description:
 *
 * History:
 *
 * 
 */

Anything more complex is just annoying.

Answer 5

Have a look at these questions:

• http://stackoverflow.com/questions/318835/do-you-add-information-to-the-top-of-each-hpp-cpp-file
• http://stackoverflow.com/questions/718783/are-comment-headers-and-footers-in-your-code-really-necessary
• http://stackoverflow.com/questions/921050/best-practice-for-comments-in-java-source-files

Answer 6

I personally use the same comments as the javadoc ones

/**
 * Your comment here 
 */

Answer 7

Any initial comment block is a wast of space if you have a version tracking software.