php类的方法注释规范

一个好的注释有非常大的作用,符合规范的注释,在调用时,编辑器会直接显示注释信息,这样能增加团队协作的速度和能力。注释规范如下。

/**
     * 方法描述
     * @access private
     * @author AT路遥
     * @version 1.0
     * @param mixed $arg1 参数一的说明
     * @param mixed $arg2 参数二的说明
     * @param mixed $mixed 这是一个混合类型
     * @return array or null
     */

效果:

原文地址:http://blog.51cto.com/13468761/2318783

时间: 2024-08-27 13:41:24

php类的方法注释规范的相关文章

IDEA设置类、方法注释模板

类注释模板 File -> Other Setting -> Default Setting打开默认设置 Editor -> File and Code Templates -> Files -> Class 找到类注释模板,在public class前面添加模板注释 /** * @program: ${PROJECT_NAME}->${NAME} * @description: ${description} * @author: qiuyu * @create: ${

IDEA类和方法注释模板设置

在开发中使用idea的注释总结:由于IDEA自带的注释模板不是太好用,所以整理一下适用于自己的模板: 一.首先我们来设置IDEA中类的模板:(IDEA中在创建类时会自动给添加注释) 1.File-->settings-->Editor-->File and Code Templates-->Files 我们选择Class文件(当然你要设置接口的还也可以选择Interface文件) (1)${NAME}:设置类名,与下面的${NAME}一样才能获取到创建的类名 (2)<p>

IDEA类和方法注释模板设置(非常详细)

IDEA自带的注释模板不是太好用,我本人到网上搜集了很多资料系统的整理了一下制作了一份比较完整的模板来分享给大家,我不是专业玩博客的,写这篇文章只是为了让大家省事. 这里设置的注释模板采用Eclipse的格式,下面先贴出Eclipse的注释模板,我们就按照这种格式来设置: 类注释模板:                                                                      方法注释模板:       一.首先我们来设置IDEA中类的模板:(IDE

c#的注释规范

1     规范目的 一个软件的生命周期中,80%的花费在于维护: 几乎没有任何一个软件,在其整个生命周期中,均由最初的开发人员来维护: 编码规范可以改善软件的可读性,可以让程序员尽快而彻底地理解新的代码.为了执行规范,每个软件开发人员必须一致遵守编码规范: 使用统一编码规范的主要原因,是使应用程序的结构和编码风格标准化,以便于阅读和理解这段代码: 好的编码约定可使源代码严谨.可读性强且意义清楚,与其它语言约定相一致,并且尽可能的直观. 2    例子          3    方法注释规范

自定义类工厂方法

1.自定义工厂方法 什么是工厂方法(快速创建方法) 类工厂方法是一种用于分配.初始化实例并返回一个它自己的实例的类方法.类工厂方法很方便,因为它们允许您只使用一个步骤(而不是两个步骤)就能创建对象. 例如new 自定义类工厂方法的规范 (1)一定是+号开头 (2)返回值一般是instancetype类型 (3)方法名称以类名开头,首字母小写 示例 + (id)person; + (id)person { return [[Person alloc]init]; } + (id)personWit

24-oc类工厂方法和类对象基本概念

类工厂方法 用于快速创建对象的类方法, 我们称之为类工厂方法 类工厂方法应用场景 类工厂方法中主要用于给对象分配存储空间和初始化这块存储空间 类工厂方法使用规范 规范: 一定是类方法 + 方法名称以类的名称开头, 首字母小写 一定有返回值, 返回值是id/instancetype 在类工厂方法实现中,调用本类的构造方法,创建实例对象,并返回实例对象 自定义类工厂方法是苹果的一个规范, 一般情况下, 我们会给一个类提供自定义构造方法和自定义类工厂方法用于创建一个对象 类工厂方法在继承中的注意点 以

C#1(.net和C#的关系、VS与.net的对应关系、VS2012常用的几种应用程序、C#定义一个类的方法、类页面内容的解释、定义Person的类、调用Person类的方法、命名规范、数值类型)

1..net和C#的关系 .net是一个开发平台,C#是应用在.net平台上的一种语言.   2.VS与.net的对应关系  3.VS2012常用的几种应用程序 第一种是Windows窗体应用程序,也即是我们常用的C/S端的应用软件: 第二种是控制台应用程序,主要是用来学习调试C#代码的(老师上课应用的模式): 第三种是空Web应用程序,建立空的网页模式,B/S模式: 第四种是Web 窗体应用程序,建立后会生成一些常用的网页组件和功能,例如JS.image等,也是B/S模式. 4.C#定义一个类

idea live template高级知识, 进阶(给方法,类,js方法添加注释)

为了解决用一个命令(宏)给方法,类,js方法添加注释,经过几天的研究.终于得到结果了. 实现的效果如下: 给Java中的method添加方法: /** * * @Method : addMenu * @Description : * @param menu : * @return : cn.yiyizuche.common.base.ResultMsg * @author : Rush.D.Xzj * @CreateDate : 2017-06-12 星期一 18:17:42 * */publi

ios 对方法的注释规范

一些小东西在此记录一下,以后会断断续续的记录下来其他的小知识,有时间可以翻来看看.1------关于ios注释规范 /** * @brief 带字符串参数的方法. * * @param valueOne 值. * @param valueTwo 值. * @return 返回value. * * @exception NSException 可能抛出的异常. * * @see someMethod * @see someMethodByInt: * @warning 警告: appledoc中显