Posted By

engel on 11/28/07


Tagged

template function example parameters description requirements notes author


Versions (?)

Who likes this?

3 people have marked this snippet as a favorite

vali29
zingo
LordBumpet


Function Template


 / Published in: PHP
 

Add this template before functions in a library, in order to give a good description of what it is and what it does. Replace all in < and > with your values.

  1. /*
  2. Function: <Function, ex. my_function( $param1, $param2 )>
  3. Description: <Description of what it does>
  4. Parameters: <Parameters for function>
  5. Example: <Show an example of your function in use, ex. my_function( "thisparameter", "newparameter");>
  6. Requirements: <Anything that your function requires>
  7. Notes: <Any other comments you have>
  8. Author: <your name and email/website address>
  9. */

Report this snippet  

You need to login to post a comment.