Quality Management:Templates/Source Code file header: Difference between revisions
Jump to navigation
Jump to search
(Created page with "__NOTOC__ =={{SUBPAGENAME}}== 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 upd...") |
No edit summary |
||
Line 12: | Line 12: | ||
WSDL file header: | WSDL file header: | ||
<syntaxhighlight lang="html5"> | <syntaxhighlight lang="html5"> | ||
<?xml version="1.0" encoding="utf-8"?> | |||
<!-- ------------------------------------------------------------------------ --> | |||
<!-- History --> | |||
<!-- Ver. Date Author Description --> | |||
<!-- ------------------------------------------------------------------------ --> | |||
<!-- 1 [YYYY.MM.DD] JCA, VP New file --> | |||
<!-- 2 [YYYY.MM.DD] JCA [Change description] --> | |||
<!-- --> | |||
<!-- Description --> | |||
<!-- ------------------------------------------------------------------------ --> | |||
<!-- This is the first Web Service, for the SDS system --> | |||
<!-- --> | |||
<!-- ------------------------------------------------------------------------ --> | |||
.... | |||
</syntaxhighlight> | </syntaxhighlight> | ||
PHP file header: | PHP file header: | ||
<syntaxhighlight lang="php"> | <syntaxhighlight lang="php"> | ||
< | <?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] | |||
* | |||
*/ | |||
... | |||
?> | |||
</syntaxhighlight> | </syntaxhighlight> | ||
Line 24: | Line 57: | ||
<syntaxhighlight lang="JavaScript"> | <syntaxhighlight lang="JavaScript"> | ||
<script type="text/javascript"> | <script type="text/javascript"> | ||
/** | |||
* [ Not defined yet. See PHP example] | |||
* | |||
*/ | |||
</script> | </script> | ||
</syntaxhighlight> | </syntaxhighlight> |
Revision as of 01:03, 10 June 2012
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"?>
<!-- ------------------------------------------------------------------------ -->
<!-- History -->
<!-- Ver. Date Author Description -->
<!-- ------------------------------------------------------------------------ -->
<!-- 1 [YYYY.MM.DD] JCA, VP New file -->
<!-- 2 [YYYY.MM.DD] JCA [Change description] -->
<!-- -->
<!-- Description -->
<!-- ------------------------------------------------------------------------ -->
<!-- This is the first Web Service, for the SDS system -->
<!-- -->
<!-- ------------------------------------------------------------------------ -->
....
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. |