位置: 编程技术 - 正文

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文件锁并发 性能)

  • 进项税额转出意思是下月还得缴吗
  • 从公司提款需要交税?
  • 出口销售收入要交增值税吗
  • 增值税专用发票明细太多怎么办
  • 购房发票是不是增值税
  • 装水表财务是什么费用
  • 净流动负债和流动负债
  • 职工年平均工资是什么意思
  • 月末结存材料的实际成本怎么计算
  • 什么是法?法的本质特征是什么
  • 哪些情况下超市销售发霉食品免责
  • 减税降费新政策解读
  • 车间扫帚存放架子
  • 发票作废了还能查验吗
  • 服装外贸进出口
  • 企业增速怎么算
  • 往来款核销需要如何确认
  • 申请出具商标注意事项
  • 什么是汇兑损益,汇兑损益产生的原因有哪些?(10分)
  • 如何让游戏速度加快
  • linux进程操作命令
  • 清除文件夹exe病毒工具
  • php 正则表达式
  • 什么是集成显卡长什么样
  • 若依框架前端框架
  • php image
  • 解决安装后软件icon一圈白边问题
  • 城建税10%用于教育哪方面
  • 广告费可以结转几年扣除
  • 长期借款利息的账务处理涉及的会计科目有
  • 获取企业微信用户身份信息授权失败
  • 销售返利的会计处理方法
  • 会计上弥补亏损
  • 金蝶软件利润表公式怎么设置
  • 工资计提和发放能不能在一个月
  • wordpress怎么添加图片
  • 帝国cms整合Elasticsearch
  • 差旅费算直接人工吗
  • 下列项目的进项税额可以从销售税额中抵扣的是
  • 劳务报酬需要申报个税吗
  • mysql数据库简单介绍
  • 对公账户有法律效力吗
  • 用人单位垫付生育津贴垫付金额和垫付天数
  • 中标服务费如何赋码
  • 老板自己出钱买办公用品怎么做账
  • 单位内部食堂怎么收费
  • 签订三方协议是办理实时扣税的前提,这里三方是指
  • 先收票后收货
  • 如何冲减计提费用
  • 补提去年累计折旧
  • 税控维护费跨年怎么算
  • 公司筹建期间预算怎么写
  • “财务报表分析”
  • 公司年底做财务报表什么吗
  • 银行回单自助打印可以打多久的记录
  • 免税收入怎么申报增值税
  • 颁发数字证书要符合什么条件
  • 工资完税证明怎么开
  • Mysql优化sql方案
  • 5分钟了解环保币gec
  • 如何查看文件系统
  • windows快速预览
  • vsftpd 550错误
  • Win10 Mobile build 14393.189安装与上手体验视频
  • win10 系统软件
  • win7连接路由器设置
  • 如何设置打开wincc不弹出项目管理
  • nodejs实战教程
  • anaconda使用指南
  • cocos2djs
  • c#中init
  • python 正则 \s
  • python操作json数据
  • 实现断点续传的工具软件
  • python添加用户并加入到相应组
  • 国税局征收的税种有哪些?
  • 成都税务二维码扫描
  • 美丽重生李晓晓免费阅读
  • 税务筹划企业所得税案例分析题
  • 计算土地增值税时下列费用准予从收入总额中扣除的有
  • 免责声明:网站部分图片文字素材来源于网络,如有侵权,请及时告知,我们会第一时间删除,谢谢! 邮箱:opceo@qq.com

    鄂ICP备2023003026号

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

    友情链接: 武汉网站建设