C Code template
C File[edit]
/*----------------------------------------------------------------------------|
| |
| C Module |
| |
|----------------------------------------------------------------------------*/
/**
- \file <filename>
- \autor <author's name> [<author's company>]
- \brief <description>
- History
- yyyy-mm-dd : <SWCHG> <author> [<platform> <release>] <History comment>
- /
/*----------------------------------------------------------------------------|
| |
| Copyright (c) 2015, Aalders IT Experience (including affiliates). |
| All rights reserved |
| |
|----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------|
| System Includes |
|----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------|
| Other Components Includes |
|----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------|
| Own Component Includes |
|----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------|
| Module Defines |
|----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------|
| Module Type Definitions |
|----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------|
| Module Function Prototypes |
|----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------|
| Module Global data |
|----------------------------------------------------------------------------*/
/*#-------------------------------------------------------------------------#*/
int function_name(const int par1, char *par2_ptr)
/**
* \brief <some description>
* \param[in] par1 <description>
* \param[in,out] none
* \param[out] par2_ptr <description>
* \returns
* \retval
* \pre
* \post
* \note Some very
* long note.
*/
{
int result = OK;
/*... function continues ...*/
return result;
} /* End <function_name> */
/*---------------------------------- End of file ----------------------------*/
</source>
Header File[edit]
<source lang="c">
/*----------------------------------------------------------------------------|
| |
| Header file |
| |
|-----------------------------------------------------------------------------|
/**
- \file <filename>
- \autor <author's name> [<author's company>]
- \brief <description>
- History
- yyyy-mm-dd : <SWCHG> <author> [<platform> <release>] <History comment>
- /
|-----------------------------------------------------------------------------|
| |
| Copyright (c) 2015, Aalders IT Experience (including affiliates). |
| All rights reserved |
| |
|----------------------------------------------------------------------------*/
- ifndef <THISFILE_H>
- define <THISFILE_H>
/*----------------------------------------------------------------------------|
| System Includes |
|----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------|
| ASML Environment Includes |
|----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------|
| Other components Includes |
|----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------|
| Own Component Includes |
|----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------|
| Module exported defines |
|----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------|
| Module exported typedefinitions |
|----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------|
| Module Exported Global data |
|----------------------------------------------------------------------------*/
/*----------------------------------------------------------------------------|
| Module Exported functions |
|----------------------------------------------------------------------------*/
- endif /* <THISFILE_H> */
/*---------------------------------- End of file ----------------------------*/
