PHPDocument code comment standard writing summary
-
/**
- * File name (sample2.php)
- * By bbs.it-home.org
- * Function description (omitted)
- * @ Package sample2
- */
-
/**
- * Contains files
- */
- Include_once 'sample3. php ';
-
/**
- * Declare global variables
- * @ Global integer $ GLOBALS ['_ myvar']
- * @ Name $ _ myvar
- */
- $ GLOBALS ['_ myvar'] = 6;
-
/**
- * Declare a global constant
- */
- Define ('num', 6 );
-
/**
- * Class name
- *
- * Class function description
- *
- * @ Package sample2
- * @ Subpackage classes (if it is a parent class, add it)
- */
- Class myclass {
-
/**
- * Declare common variables
- *
- * @ Accessprivate
- * @ Var integer | string
- */
- Var $ firstvar = 6;
-
/**
- * Create a constructor {@ link $ firstvar}
- */
- Function myclass (){
- $ This-> firstvar = 7;
- }
-
/**
- * Define functions
- *
- * Function description
- *
- * @ Global string $ _ myvar
- * @ Staticvar integer $ staticvar
- * @ Param string $ param1
- * @ Param string $ param2
- * @ Return integer | string
- */
- Function firstFunc ($ param1, $ param2 = 'optional '){
- Static $ staticvar = 7;
- Global $ _ myvar;
- Return $ staticvar;
- }
- }
- ?>
|