Difference between revisions of "C Code template"

From
Jump to: navigation, search
(Created page with " == C File == <source lang="c"> /*----------------------------------------------------------------------------| |...")
 
Line 2: Line 2:
 
== C File ==
 
== C File ==
  
−
<source lang="c">
+
<code lang="c">
 
/*----------------------------------------------------------------------------|
 
/*----------------------------------------------------------------------------|
 
|                                                                            |
 
|                                                                            |
Line 141: Line 141:
 
   
 
   
 
/*---------------------------------- End of file ----------------------------*/
 
/*---------------------------------- End of file ----------------------------*/
−
</source>
+
</code>
  
 
[[category:Code Templates]]
 
[[category:Code Templates]]

Revision as of 19:26, 6 October 2019

C File

/*----------------------------------------------------------------------------| | | | 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 | | | |----------------------------------------------------------------------------*/

  1. ifndef <THISFILE_H>
  2. 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 | |----------------------------------------------------------------------------*/


  1. endif /* <THISFILE_H> */

/*---------------------------------- End of file ----------------------------*/

Retrieved from "http://wiki.jeroenaalders.nl/index.php?title=C_Code_template&oldid=25"