TICS Coding Standard Viewer 
TIOBE Software Quality Framework
Print-friendly version
©TIOBE Software www.tiobe.com
 
ASML C Coding Standard
Search

Rule:  5.1.1.bChecked automatically with code checker

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. The copyright statement should be identical to the example shown below (only the years might differ or may contain only one year).

Example

/*------------------------------------------------------------------------------
|
|                                   C Module
|
|-------------------------------------------------------------------------------
|
| Filename   : CC_module.c
| Description: 
|
|-------------------------------------------------------------------------------
|
|                  Copyright (c) 2013-2021, My Company Name
|                             All rights reserved
|
|-----------------------------------------------------------------------------*/