Home/ Questions/Q 199217
In Process

The Archive Base Latest Questions

Editorial Team
  • 0
Asked: 2026-05-11T17:00:16+00:00

What information do you consider worth to put in the comment at the beginning

  • 0

What information do you consider worth to put in the comment at the beginning of a sourcecode file?

All I could think about was the name of the author and perhaps the date the file was created (although I’m not to sure if there is any useful value to this information).

[EDIT] To clarify, I don’t mean comments before a class, but at the first lines of the file, before include statements and what else. Like

/**
 * Author:    Name
 * Created:   11.05.2009
 * 
 * (c) Copyright by Blub Corp.
 **/
Share

Leave an answer

You must login to add an answer.

Need An Account,

1 Answer

  1. Editorial Team

    What to put in the file header:

    • Library/component that source code is part of
    • Copyright details
    • Brief and meaningful description of class(es) in source file

    What NOT to put in the file header:

    • Anything that duplicates low level logic which is part of the code itself. This can lead to maintenance problems if it isn’t updated when the source code changes.

    • Author name(s). Why?

      • In the world of revision control systems, while there may be an initial author of some code, eventually ownership becomes blurred. This is especially true when code enters the maintenance phase of the life cycle where owners can change regularly.
      • All code eventually becomes “community wiki” after enough changes 😉
      • Would you want your name associated with all of the code forever, knowing full well that you will not be responsible for the code until its death?

    • Creation and last changed dates. This is for similar reasons as list above. Revision control includes this information – why duplicate it in the header, making more work for yourself and risking leaving inaccurate information in the comment when things inevitably change?

    • 0