位置: 编程技术 - 正文

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

  • 个税免申报什么时候申报
  • 清税证明是什么要钱吗
  • 增值税电子普通发票怎么作废
  • 厂房设计费计入在建工程吗
  • 往期企业所得税申报记录怎么查
  • 一般纳税人税收优惠政策有哪些2023年
  • 发票上的密码区有什么用
  • 会计核算体系的中心环节是什么
  • 研发费用加计扣除条件
  • 签证费怎么支付
  • 房地产税和物业税
  • 保险赔款个人所得税计算
  • 营改增的主要内容
  • 安装过程中材料和工资
  • 公司付给职工的工资
  • 托收承付销售货物什么意思
  • 个人开增值税普通发票税率
  • 有关税收的征收管理规定介绍
  • 建筑服务安装费发票需要备注什么
  • 税务登记都需要什么
  • 四川中级会计报名需要上传哪些资料
  • 财务费用错记成管理费用
  • uefi+bios
  • 应收票据借贷方核算什么内容
  • 公司个人股份转让需要缴税吗
  • 应纳税所得额怎么理解
  • 坏账的税务处理方法
  • 栀子花叶子发黄是什么原因
  • php fileinfo
  • 实收资本大于注册资本是什么意思
  • 税前扣除的比例
  • 小规模与一般纳税人做账区别
  • vue查看图片组件
  • grid-column
  • uniapp微信公众号授权
  • 全网首发是什么意思
  • vue.js如何安装
  • 会计做账需要银行交易明细吗
  • 所有者权益总计怎么算沙盘
  • 为什么开发票能抵税
  • 已认证的发票
  • 哪些人不要申报个税
  • 优先股股息必须支付吗
  • 帝国cms相关文章调用
  • 固定资产折旧如何计算公式
  • 所得税预缴申报表资产总额怎么填
  • 根据工资总额组成的规定下列哪些列入工资总额的范围
  • sql server 2008简介
  • 工业企业库存商品的初始入账成本
  • 跨境收入免增值税需做备案吗
  • 公司会计日常工作内容
  • 收购固定资产账务处理
  • 小微企业全年营业额不能超过多少
  • 本年计算扣除限额的基数计算公式
  • 已付款发票未到怎么做分录
  • 印花税计入什么会计分录
  • 购买东西进项税额怎么算
  • 去国外参加展会办什么签证
  • 处置子公司如何合并
  • 企业净资产怎么填
  • 商业企业包装物包括哪些
  • mysql存储引擎面试题
  • sql语句去除重复值
  • XP系统怎么调节屏幕亮度
  • shell 日期运算
  • win8关机后自动重启怎么办
  • winxp修改ip地址方法
  • vsftpd.log
  • win10预览文件怎么显示内容
  • opengl光照效果
  • ExtJS 2.0实用简明教程 之获得ExtJS
  • python 入门指南
  • angular获取数据给后端
  • pygame 安装
  • jq监听input框value值
  • shell去重计数
  • jqueryw3c
  • 青海国税发票查询系统
  • 发票代码如何查询公司
  • 小学的困难补助什么时候发
  • 免责声明:网站部分图片文字素材来源于网络,如有侵权,请及时告知,我们会第一时间删除,谢谢! 邮箱:opceo@qq.com

    鄂ICP备2023003026号

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

    友情链接: 武汉网站建设