Community Learn Tools Library Leisure
search
English
Home > Backend Development > PHP Tutorial > Summary of standard writing methods for PHPDocument code comments

Summary of standard writing methods for PHPDocument code comments

WBOY
Release： 2016-07-25 08:57:10
Original
988 people have browsed it

  3. /**

  4. * File name (sample2.php)
  5. * by bbs.it-home.org
  6. * Function description (omitted)
  7. * @package sample2
  8. */

  9. /**

  10. * Included files
  11. */
  12. include_once 'sample3.php';

  13. /**

  14. * Declare global variables
  15. * @global integer $GLOBALS['_myvar']
  16. * @name $_myvar
  17. */
  18. $GLOBALS['_myvar'] = 6;

  19. /**

  20. * Declare global constants
  21. */
  22. define('NUM', 6);

  23. /**

  24. * Class name
  25. *
  26. * Class function description
  27. *
  28. * @package sample2
  29. * @subpackage classes (if it is a parent class, add it)
  30. */
  31. class myclass {

  32. /**

  33. * Declare ordinary variables
  34. *
  35. * @accessprivate
  36. * @var integer|string
  37. */
  38. var $firstvar = 6;

  39. /**

  40. * Create constructor {@link $firstvar}
  41. */
  42. function myclass() {
  43. $this->firstvar = 7;
  44. }

  45. /**

  46. * Define function
  47. *
  48. * Function description
  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. ?>

复制代码


Related labels：
PHPDocument 代码注释的规范写法总结
source：php.cn
Previous article：PHP code to check whether a number is odd or even Next article：Parse == and === (double equal sign, triple equal sign) in php
Statement of this Website
The content of this article is voluntarily contributed by netizens, and the copyright belongs to the original author. This site does not assume corresponding legal responsibility. If you find any content suspected of plagiarism or infringement, please contact admin@php.cn
Latest Articles by Author
Latest Issues
function_exists() cannot determine the custom function Function test () {return true;} if (function_exists ('test')) {echo "test is function...
From 2024-04-29 11:01:01
0
3
2275
How to display the mobile version of Google Chrome Hello teacher, how can I change Google Chrome into a mobile version?
From 2024-04-23 00:22:19
0
11
2409
The child window operates the parent window, but the output does not respond. The first two sentences are executable, but the last sentence cannot be implemented.
From 2024-04-19 15:37:47
0
1
2026
There is no output in the parent window document.onclick = function(){ window.opener.document.write('I am the output of the child ...
From 2024-04-18 23:52:34
0
1
1914
Where is the courseware about CSS mind mapping? Courseware
From 2024-04-16 10:10:18
0
0
1981
Related Topics
More>
Popular Recommendations
Popular Tutorials
More>
Related Tutorials
Popular Recommendations
Latest courses
Latest Downloads
More>
Web Effects
Website Source Code
Website Materials
Front End Template