Difference between revisions of "C Code template"
| Line 2: | Line 2: | ||
== C File == | == C File == | ||
| − | + | {{code}} | |
/*----------------------------------------------------------------------------| | /*----------------------------------------------------------------------------| | ||
| | | | | | ||
| Line 141: | Line 141: | ||
/*---------------------------------- End of file ----------------------------*/ | /*---------------------------------- End of file ----------------------------*/ | ||
| − | + | {{code}} | |
[[category:Code Templates]] | [[category:Code Templates]] | ||
Revision as of 19:27, 6 October 2019
C File
Template:Code /*----------------------------------------------------------------------------| | | | 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
<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 ----------------------------*/ Template:Code
