Quality Management:Templates/Source Code file header

From PMISwiki
Jump to navigation Jump to search
The printable version is no longer supported and may have rendering errors. Please update your browser bookmarks and please use the default browser print function instead.


Source Code file header

We use the file header to ensure that the following meta data always is available:

  • When the file was created and by whom.
  • When the file was updated, by whom and why.

Each project may define its own format. The following templates are for inspiration:

Examples

WSDL file header:

<?xml version="1.0" encoding="utf-8"?>
<definitions name="sds" ....>
    <wsdl:documentation>
    ----------------------------------------------------------------------------------------------------------
    History
    Version	Date		Author			Description
    ----------------------------------------------------------------------------------------------------------
    	1	[YYYY/MM/DD]	JCA,VP	                 New file
        2	[YYYY/MM/DD]	JCA, 	                 ...
    ----------------------------------------------------------------------------------------------------------
    Description:
    This is the first Web Service, for the SDS System....
    ----------------------------------------------------------------------------------------------------------
    All rights reserved: Virtual Team A/S
    </wsdl:documentation>
....

PHP file header:

<?php
/**
* Filename:  fileName.php
* ==============================================================================
* History
* Ver.  Date     Author Description
* ==============================================================================
*  1 [YYYY.MM.DD]  PSA  New file
*  2 [YYYY.MM.DD]  PSA  [Change description]
*
* Description
* ==============================================================================
* [Functionnal description]
*
* [Documentation]
*   
* [TO do list]
*  
*/
...
?>

JavaScript file header:

<script type="text/javascript">
/**
*  [ Not defined yet. See PHP example]
*
*/
</script>

References

Document History

Version Date Author Status Purpose of update
1 08 Jun 2012 PSA Draft Not released.
2 12 Jun 2012 PSA Approved Input from JCA.