当前位置:Gxlcms > PHP教程 > PHPDocument代码注释的规范写法总结

PHPDocument代码注释的规范写法总结

时间:2021-07-01 10:21:17 帮助过:35人阅读

  1. /**

  2. * 文件名(sample2.php)
  3. * by bbs.it-home.org
  4. * 功能描述(略)
  5. * @package sample2
  6. */

  7. /**

  8. * 包含文件
  9. */
  10. include_once 'sample3.php';

  11. /**

  12. * 声明全局变量
  13. * @global integer $GLOBALS['_myvar']
  14. * @name $_myvar
  15. */
  16. $GLOBALS['_myvar'] = 6;

  17. /**

  18. * 声明全局常量
  19. */
  20. define('NUM', 6);

  21. /**

  22. * 类名
  23. *
  24. * 类功能描述
  25. *
  26. * @package sample2
  27. * @subpackage classes(如果是父类 就添加)
  28. */
  29. class myclass {

  30. /**

  31. * 声明普通变量
  32. *
  33. * @accessprivate
  34. * @var integer|string
  35. */
  36. var $firstvar = 6;

  37. /**

  38. * 创建构造函数 {@link $firstvar}
  39. */
  40. function myclass() {
  41. $this->firstvar = 7;
  42. }

  43. /**

  44. * 定义函数
  45. *
  46. * 函数功能描述
  47. *
  48. * @global string $_myvar
  49. * @staticvar integer $staticvar
  50. * @param string $param1
  51. * @param string $param2
  52. * @return integer|string
  53. */
  54. function firstFunc($param1, $param2 = 'optional') {
  55. static $staticvar = 7;
  56. global $_myvar;
  57. return $staticvar;
  58. }
  59. }
  60. ?>

人气教程排行