Synopsis: | Each source file shall start with a file header, for which the "file name", "description" and copyright notice are to be filled in. |
Language: | C |
Severity Level: | 8 |
Category: | Conceptual Models |
Description: |
Justification Enough information should be provided in the header to be able to understand the functionality without reading the source code. A copyright notice describes the legal ownership of the file. When editing a source file you can consider to update the copyright header:
The year you state should be the year that the work is created. If a change is substantial enough to give right to a new copyright, then that year should be mentioned too. The most important year is the first year. When a SW developer encounters copyright statements in existing source files that are old or wrong, then they should:
Example /*------------------------------------------------------------------------------ | | C Module | |------------------------------------------------------------------------------- | | Filename : CC_module.c | Description: |