PHP注释语法规范与命名规范
注释在写代码的过程中非常重要,好的注释能让你的代码读起来更轻松,在写代码的时候一定要注意注释的规范,这里脚本之家小编就为大家整理一下,需要的朋友可以参考下。
HP注释规范
注释在写代码的过程中非常重要,好的注释能让你的代码读起来更轻松,在写代码的时候一定要注意注释的规范。
“php是一门及其容易入门的语言,刚入门的新手不到几分钟的时间可能就会用echo打印出一个hello world !但是他是真正的程序员吗?怎么来定义程序员呢?如果想真正成为一个程序员,那么就必须遵循一套程序书写规范,”
我们经常编写一些函数,但是这些函数可能也只有自己能看得懂,甚至过一段时间自己也不认识自己写的了,那么怎么办呢?最好的办法当然是给给自己的代码加上注释。
我们可能熟悉很多注释的写法C pear PHP注释等等,但我们用到的主要还是# 和/**/。
#是一种简短的注释方法。可能你会用它去注释一个变量,或者调用的一个方法。/**/我们可能还在用它去注释掉一大段代码,但是怎么用它去标准的注释一个函数呢?
/** * @name 名字 * @abstract 申明变量/类/方法 * @access 指明这个变量、类、函数/方法的存取权限 * @author 函数作者的名字和邮箱地址 * @category 组织packages * @copyright 指明版权信息 * @const 指明常量 * @deprecate 指明不推荐或者是废弃的信息 * @example 示例 * @exclude 指明当前的注释将不进行分析,不出现在文挡中 * @final 指明这是一个最终的类、方法、属性,禁止派生、修改。 * @global 指明在此函数中引用的全局变量 * @include 指明包含的文件的信息 * @link 定义在线连接 * @module 定义归属的模块信息 * @modulegroup 定义归属的模块组 * @package 定义归属的包的信息 * @param 定义函数或者方法的参数信息 * @return 定义函数或者方法的返回信息 * @see 定义需要参考的函数、变量,并加入相应的超级连接。 * @since 指明该api函数或者方法是从哪个版本开始引入的 * @static 指明变量、类、函数是静态的。 * @throws 指明此函数可能抛出的错误异常,极其发生的情况 * @todo 指明应该改进或没有实现的地方 * @var 定义说明变量/属性。 * @version 定义版本信息 */
注释的信息很全面,可能有很多我们用不到,红色部分是我们经常用到的。
示例:php里面常见的几种注释方式:
1.文件的注释,介绍文件名,功能以及作者版本号等信息
/** * 文件名简单介绍 * * 文件功能 * @author 作者 * @version 版本号 * @date 2020-02-02 */
文件头部模板
/** *这是一个什么文件 * *此文件程序用来做什么的(详细说明,可选。)。 * @author richard<e421083458@163.com> * @version $Id$ * @since 1.0 */
2.类的注释,类名及介绍
/** * 类的介绍 * * 类的详细介绍(可选) * @author 作者 * @version 版本号 * @date 2020-02-02 */
/** * 类的介绍 * * 类的详细介绍(可选。)。 * @author richard<e421083458@163.com> * @since 1.0 */ class Test { }
3.函数的注释,函数的作用,参数介绍以及返回类型
/** * 函数的含义说明 * * @access public * @author 作者 * @param mixed $arg1 参数一的说明 * @param mixed $arg2 参数二的说明 * @return array 返回类型 * @date 2020-02-02 */
函数头部注释
/** * some_func * 函数的含义说明 * * @access public * @param mixed $arg1 参数一的说明 * @param mixed $arg2 参数二的说明 * @param mixed $mixed 这是一个混合类型 * @since 1.0 * @return array */ public function thisIsFunction($string, $integer, $mixed) {return array();}
程序代码注释
1. 注释的原则是将问题解释清楚,并不是越多越好。
2. 若干语句作为一个逻辑代码块,这个块的注释可以使用/* */方式。
3. 具体到某一个语句的注释,可以使用行尾注释://。
/* 生成配置文件、数据文件。*/ $this->setConfig(); $this->createConfigFile(); //创建配置文件 $this->clearCache(); // 清除缓存文件 $this->createDataFiles(); // 生成数据文件 $this->prepareProxys(); $this->restart();
PHP命名规范
1.目录和文件
目录使用小写+下划线
类库,函数文件统一以.php为后缀
类的文件名均以命名空间定义,并且命名空间的路径和类库文件所在路径一致
类文件采用驼峰法命名(首字母大写),其他文件采用小写+下划线命名
类名和类文件名保持一致,统一采用驼峰法(首字母大写)
2.函数和类,属性命名
类的命名采用驼峰法(首字母大写),例如 User、UserType,默认不需要添加后缀,例如UserController应该直接命名为User
函数的命名使用小写字母和下划线(小写字母开头)的方式,例如 get_client_ip
方法的命名使用驼峰法(首字母小写),例如 getUserName(如果方法有返回值,那么目前习惯上将首字母用小写的属性类型,如s(string),i(int),f(float),b(boolean),a(array)等)
属性的命名使用驼峰法(首字母小写),例如 tableName、instance(目前习惯上将首字母用小写的属性类型,如s(string),i(int),f(float),b(boolean),a(array)等)
以双下划线“__”打头的函数或方法作为魔法方法,例如 __call 和 __autoload
3.常量和配置
常量以大写字母和下划线命名,例如 APP_PATH和 THINK_PATH
配置参数以小写字母和下划线命名,例如 url_route_on 和url_convert
4.数据表盒字段
数据表和字段采用小写加下划线方式命名,并注意字段名不要以下划线开头,例如 think_user 表和 user_name字段,不建议使用驼峰和中文作为数据表字段命名。

热AI工具

Undresser.AI Undress
人工智能驱动的应用程序,用于创建逼真的裸体照片

AI Clothes Remover
用于从照片中去除衣服的在线人工智能工具。

Undress AI Tool
免费脱衣服图片

Clothoff.io
AI脱衣机

AI Hentai Generator
免费生成ai无尽的。

热门文章

热工具

记事本++7.3.1
好用且免费的代码编辑器

SublimeText3汉化版
中文版,非常好用

禅工作室 13.0.1
功能强大的PHP集成开发环境

Dreamweaver CS6
视觉化网页开发工具

SublimeText3 Mac版
神级代码编辑软件(SublimeText3)

PHP注释大揭秘:单行注释和多行注释详细对比PHP是一种广泛应用的网页开发语言,其中注释的使用对于代码的可读性和维护性起着至关重要的作用。在PHP中,常见的注释有单行注释和多行注释两种形式。本文将详细对比这两种注释形式,并提供具体的代码示例,帮助读者更好地理解它们的用法和差异。一、单行注释单行注释是在代码中添加一行注释,以//开头,直到行尾为止。单行注释

php注释的种类有单行注释、多行注释、文档注释和条件注释等。详细介绍:1、单行注释以双斜杠“//”开头,用于注释单行代码,在这种注释类型中,从双斜杠开始到该行末尾的所有内容都将被视为注释,不会被解释为代码;2、多行注释以斜杠星号“/”开头,以星号斜杠“*/”结尾,这种注释类型可用于注释一段代码或多行代码;3、文档注释也以斜杠星号“/”开头,以星号斜杠“*/”结尾等等。

代码注释是程序员在编写代码时添加的文本提醒,以便自己和其他程序员更轻松地阅读和理解代码。在PHP中,代码注释是不可或缺的。本文将详细介绍PHP中的代码注释的类型、规范和用途。一、PHP中的代码注释类型在PHP中,有三种类型的注释:单行注释、多行注释和文档注释。单行注释单行注释以双斜线“//”开始,直到行尾结束。例如://这是一个单行注释多行注释多行注释以“

php的注释种类有:1、单行注释,用于解释某个功能、提醒其他开发者或自己注意点等;2、多行注释,用于对多行代码块进行详细的说明;3、文档注释,用于对整个代码块或函数、方法进行详细的说明。

进入PHP编程领域,注释是一个非常重要的概念。在编写代码时,注释对于阐述代码意图、帮助其他开发者理解代码逻辑以及方便自己日后维护代码都是至关重要的。在PHP中,注释分为单行注释和多行注释两种,在使用上有一些区别。本文将深入探讨PHP注释的特点以及单行注释和多行注释的使用方式,并通过具体的代码示例进行说明。1.单行注释单行注释是在代码中添加一行注释,用来解释

PHP注释规范:如何使用文档注释编写API文档引言:在开发PHP应用程序时,编写完善的API文档对于开发团队和其他开发者来说非常重要。好的文档可以提高代码的可读性和可维护性,并促进团队合作与信息共享。本文将介绍如何使用文档注释编写PHP的API文档,并提供一些示例代码帮助读者理解如何规范地编写注释。注释规范在PHP中,我们使用注释来对代码进行说明和描述。一般

如何在PHP中使用注释来增强代码可读性和理解性引言:在开发过程中,注释是一个非常重要的组成部分,可以帮助开发者更好地理解代码,提高代码的可读性和维护性。本文将介绍在PHP中如何使用注释来增强代码的可读性和理解性,并提供一些实际的代码示例。单行注释单行注释是用来对代码的某一行进行解释和说明。在PHP中,单行注释以双斜杠(//)开头,直到行尾结束。下面是一个示例

PHP是一种流行的服务器端脚本语言,广泛应用于Web开发领域。在代码编写过程中,注释是一个非常重要的元素,可以帮助开发者更好地理解代码,提高代码的可读性和可维护性。本文将详细介绍PHP中的注释类型,包括单行注释与多行注释,同时提供具体的代码示例。单行注释在PHP中,使用双斜杠//可以实现单行注释。单行注释从//开始一直到该行的末尾。单行注释通常用于对代码进行
