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

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

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

  3. /**

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

  9. /**

  10. * 包含文件
  11. */
  12. include_once 'sample3.php';

  13. /**

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

  19. /**

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

  23. /**

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

  32. /**

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

  39. /**

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

  45. /**

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

人气教程排行

本站所有资源全部来源于网络，若本站发布的内容侵害到您的隐私或者利益，请联系我们删除！