位置: 编程技术 - 正文

PHP编码规范之注释和文件结构说明(php的注释可以使用什么开头)

编辑:rootadmin
文件结构 |??images |??include   |??parameter   |??config   |??function |??index images存放图片文件,include中是系统是要引用的文件,一般在parameter中存放参数文件,config中存放配置文件,function中存放方法文件,如javascript的方法等,并按功能模块的分类,将各功能的类也放入其中 文件名 文件夹命名一般采用英文,长度一般不超过个字符,命名采用小写字母。除特殊情况才使用中文拼音,一些常见的文件夹命名如:images(存放图形文件),flash(存放Flash文件),style(存放CSS文件),scripts(存放Javascript脚本),inc(存放include文件),link(存放友情链接),media(存放多媒体文件)等。文件名称统一用小写的英文字母、数字和下划线的组合。 块注释 块注释通常用于提供对文件,方法,数据结构和算法的描述。块注释被置于每个文件的开始处以及每个方法之前。它们也可以被用于其他地方,比如方法内部。在功能和方法内部的块注释应该和它们所描述的代码具有一样的缩进格式。 块注释之首应该有一个空行,用于把块注释和代码分割开来,比如: /*  * 这里是块注释 */ 块注释可以以/*-开头,这样indent(1)就可以将之识别为一个代码块的开始,而不会重排它。 /*-  * 如果想被忽略,可是使用特别格式的块注释  *  * one  *   two  *     three  */ 注意:如果你不使用indent(1),就不必在代码中使用/*-,或为他人可能对你的代码运行indent(1)作让步。 单行注释 短注释可以显示在一行内,并与其后的代码具有一样的缩进层级。如果一个注释不能在一行内写完,就该采用块注释。单行注释之前应该有一个空行。以下是一个代码中单行注释的例子: if (condition) {   /* 以下代码运行的条件 */   ... } 尾端注释 极短的注释可以与它们所要描述的代码位于同一行,但是应该有足够的空白来分开代码和注释。若有多个短注释出现于大段代码中,它们应该具有相同的缩进。 以下是一个代码中尾端注释的例子: 行末注释 注释界定符"//",可以注释掉整行或者一行中的一部分。它一般不用于连续多行的注释文本;然而,它可以用来注释掉连续多行的代码段。以下是所有三种风格的例子: 文档注释 文档注释描述php的类、构造器,方法,以及字段(field)。每个文档注释都会被置于注释定界符/**...*/之中,一个注释对应一个类或成员。该注释应位于声明之前: /**  * 说明这个类的一些 ... */ class Example { ... 注意顶层(top-level)的类是不缩进的,而其成员是缩进的。描述类的文档注释的第一行(/**)不需缩进;随后的文档注释每行都缩进1格(使星号纵向对齐)。成员,包括构造函数在内,其文档注释的第一行缩进4格,随后每行都缩进5格。 若你想给出有关类、变量或方法的信息,而这些信息又不适合写在文档中,则可使用实现块注释(见5.1.1)或紧跟在声明后面的单行注释(见5.1.2)。例如,有关一个类实现的细节,应放入紧跟在类声明后面的实现块注释中,而不是放在文档注释中。 文档注释不能放在一个方法或构造器的定义块中,因为程序会将位于文档注释之后的第一个声明与其相关联。

推荐整理分享PHP编码规范之注释和文件结构说明(php的注释可以使用什么开头),希望有所帮助,仅作参考,欢迎阅读内容。

PHP编码规范之注释和文件结构说明(php的注释可以使用什么开头)

文章相关热门搜索词:php注释符号是什么,php 编码,php 编码,php注释有几种?如何表示?,php的注释有哪些?,php注释种类有哪些,php注释的主要作用是什么?,php注释有几种?如何表示?,php的注释有哪些?,内容如对您有帮助,希望把文章链接给更多的朋友!

在Windows系统上安装PHP运行环境文字教程 一.下载相关软件软件下载地址httpd-2.2.-win-x-no_ssl.

php下目前为目最全的CURL中文说明 PHP中的CURL函数库(ClientURLLibraryFunction)curl_close—关闭一个curl会话curl_copy_handle—拷贝一个curl连接资源的所有内容和参数curl_errno—返回一个包含当前会

php中定义网站根目录的常用方法 define('BASE_PATH',str_replace('\','/',realpath(dirname(__FILE__).'/../')));

标签: php的注释可以使用什么开头

本文链接地址:https://www.jiuchutong.com/biancheng/278569.html 转载请保留说明!

上一篇:PHP常用代码大全(新手入门必备)(php编程代码)

下一篇:PHP flock 文件锁详细介绍(php文件锁并发 性能)

  • 节能服务公司可以做什么
  • 出口退税计算公式 中华会计网校
  • 处置公司车辆账务处理
  • 报送会计报表
  • 资产负债表递延收益
  • 贷款利息是否能降低
  • 劳务费属于印花税范围吗
  • 小规模残疾人交多少税收
  • 物业费计入哪里
  • 市政押金无法收回的损失可以税前扣除吗
  • 实际缴纳的税款怎么算
  • 增值税申报表在哪里打印
  • 服装厂里面
  • 购入汽车
  • 工程基建期的工作总结
  • 专用发票可以开安装费吗?
  • 上月未抵扣完的进项税本月可以抵扣吗
  • 什么时候需要计算环境熵变
  • 人工智能对财务人员的挑战与机遇
  • 其他公司代付工资怎么做
  • 一般纳税人普通发票要交增值税吗
  • 购买现金支票的扣费方式
  • 餐饮店收入是销售收入吗
  • 所得税税前扣除税金有哪些
  • 如何设置电脑关机时清理使用痕迹
  • win11小组件加载内容出现错误
  • php递归算法经典实例
  • 贷款房屋评估费怎么收
  • 外企借款投资利息高吗
  • 别再等待别在徘徊是什么歌
  • php比较两个字符串
  • PHP:mcrypt_enc_get_modes_name()的用法_Mcrypt函数
  • 挪威最北部
  • java开发和运维
  • 使用session的步骤
  • 工商罚款怎么入账
  • 预缴增值税借方余额
  • 计提支付公积金
  • which 查找文件
  • 房屋租赁发票如何免税
  • Spring Boot 3.0 正式发布,王炸!!
  • 收到银行的贷款怎么入账
  • 纳税调整项目明细表利息支出怎么填
  • 手机做h5
  • 应收账款计提坏账准备是什么意思
  • 开具红字增值税专用发票信息表在哪
  • 投资性房地产对外出租的账务处理
  • PostgreSQL教程(十二):角色和权限管理介绍
  • mysql乱码问题怎么解决
  • 工程结算属于哪类账户
  • 更正会计差错的方法
  • 捐赠支出税前扣除比例
  • 固定资产报废废料收入要发票吗
  • 固定资产清理借方增加还是减少
  • 员工出差的餐费可以抵扣吗
  • 小规模纳税人交通运输服务税率
  • 制造费用和管理费用怎么结转
  • 老板用公司的钱算挪用公款吗
  • 银行固定资产有哪些
  • 企业应收票据
  • 填收入与成本明细怎么填
  • MySQL:Unsafe statement written to the binary log using statement format since BINLOG_FORMAT = STATEM
  • sql server怎么执行
  • mysql使用入门教程视频
  • freebsd怎么安装软件
  • mac系统怎么查看
  • mac系统文件名
  • centos安装位置选择
  • win8不能启动
  • xp系统操作全程图解
  • mac 地址栏
  • 如何更改忘记密码中的问题
  • cocos2dx官方文档
  • 新浪微博随时随地
  • vue gallery
  • unity3d打包apk
  • 广东电子税务系统社保1号都能申报吗
  • 进口汽车零部件编码查询
  • 知道金额,税额怎么计算
  • 吉林省税务局发票流向查询系统
  • 免责声明:网站部分图片文字素材来源于网络,如有侵权,请及时告知,我们会第一时间删除,谢谢! 邮箱:opceo@qq.com

    鄂ICP备2023003026号

    网站地图: 企业信息 工商信息 财税知识 网络常识 编程技术

    友情链接: 武汉网站建设