文章插图
说明：注释的原则是有助于对程序的阅读理解，在该加的地方都加了，注释不宜太多也不能太少，注释语言必须准确、易懂、简洁 。
/** * @version: V1.0 * @author: pmdream * @className: user * @packageName: user * @description: 类注释 * @data: 2019-9-5 11:20 **/方法注释
/*** @author: pmdream* @methodsName: addUser* @description: 添加一个用户* @param: xxxx* @return: String* @throws: **/1.注释在写代码的过程中非常重要，好的注释能让你的代码读起来更轻松，在写代码的时候一定要注意注释的规范 。
“php是一门及其容易入门的语言，刚入门的新手不到几分钟的时间可能就会用echo打印出一个hello world ！但是他是真正的程序员吗？怎么来定义程序员呢？如果想真正成为一个程序员，那么就必须遵循一套程序书写规范，”
我们经常编写一些函数，但是这些函数可能也只有自己能看得懂，甚至过一段时间自己也不认识自己写的了，那么怎么办呢？最好的办法当然是给给自己的代码加上注释 。
我们可能熟悉很多注释的写法C pear PHP注释等等，但我们用到的主要还是# 和/**/ 。
#是一种简短的注释方法 。可能你会用它去注释一个变量，或者调用的一个方法 。/**/我们可能还在用它去注释掉一大段代码，但是怎么用它去标准的注释一个函数呢？
注释在写代码的过程中非常重要，好的注释能让你的代码读起来更轻松，在写代码的时候一定要注意注释的规范 。
“php是一门及其容易入门的语言，刚入门的新手不到几分钟的时间可能就会用echo打印出一个hello world ！但是他是真正的程序员吗？怎么来定义程序员呢？如果想真正成为一个程序员，那么就必须遵循一套程序书写规范，”
我们经常编写一些函数，但是这些函数可能也只有自己能看得懂，甚至过一段时间自己也不认识自己写的了，那么怎么办呢？最好的办法当然是给给自己的代码加上注释 。
我们可能熟悉很多注释的写法C pear PHP注释等等，但我们用到的主要还是# 和/**/ 。
#是一种简短的注释方法 。可能你会用它去注释一个变量，或者调用的一个方法 。/**/我们可能还在用它去注释掉一大段代码，但是怎么用它去标准的注释一个函数呢？
/**
* @name 名字
* @abstract 申明变量/类/方法
* @access 指明这个变量、类、函数/方法的存取权限
* @author 函数作者的名字和邮箱地址
* @category 组织packages
* @copyright 指明版权信息
* @const 指明常量
* @deprecate 指明不推荐或者是废弃的信息
* @example 示例
* @exclude 指明当前的注释将不进行分析，不出现在文挡中
* @final 指明这是一个最终的类、方法、属性，禁止派生、修改 。
* @global 指明在此函数中引用的全局变量
* @include 指明包含的文件的信息
* @link 定义在线连接
* @module 定义归属的模块信息
* @modulegroup 定义归属的模块组
【PHP编程源代码常见注释规范讲解】* @package 定义归属的包的信息
* @param 定义函数或者方法的参数信息
* @return 定义函数或者方法的返回信息
* @see 定义需要参考的函数、变量，并加入相应的超级连接 。
* @since 指明该api函数或者方法是从哪个版本开始引入的
* @static 指明变量、类、函数是静态的 。
* @throws 指明此函数可能抛出的错误异常,极其发生的情况
* @todo 指明应该改进或没有实现的地方
* @var 定义说明变量/属性 。
* @version 定义版本信息
*/
注释的信息很全面，可能有很多我们用不到，红色部分是我们经常用到的 。
示例：php里面常见的几种注释方式：
1.文件的注释，介绍文件名，功能以及作者版本号等信息
/*** 文件名简单介绍* * 文件功能* @author 作者* @version 版本号* @date 2019-09-05*/文件头部模板
/** *这是一个什么文件 * *此文件程序用来做什么的（详细说明，可选 。） 。* @author richard<e421083458@163.com> * @version $Id$ * @since 1.0 */2.类的注释，类名及介绍
/*** 类的介绍* * 类的详细介绍（可选）* @author 作者* @version 版本号* @date 2019-09-05*/
/** * 类的介绍 * * 类的详细介绍（可选 。） 。* @author richard<858560031@qq.com> * @since 1.0 */3.函数的注释，函数的作用，参数介绍以及返回类型
/*** 函数的含义说明* * @access public * @author 作者* @param mixed $arg1 参数一的说明 * @param mixed $arg2 参数二的说明* @return array 返回类型* @date 2019-09-05*/函数
推荐阅读
- PHP：实现敏感词过滤的方法
- PHP实现冒泡排序
- 这篇java的NIO编程，保证你能看懂
- PHP文件访问时提示http 404错误
- php过滤只保留中文，英文以及数字的方法
- Linux Shell编程
- 计算机病毒发展史
- 直播源码搭建教程 源码教程
- PHP快速搭建本地运行环境
- PHP的缓冲区你了解过吗