位置: 编程技术 - 正文

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

  • 土地使用税怎么征收标准
  • 出口退税率怎么算
  • 广东税务师报名条件
  • 城市维护建设税的计税依据是什么
  • 免交增值税免印花税吗
  • 更正个税申报需要做账吗
  • 做了进项税转出后要结转么
  • 出售未计提完折旧的固定资产
  • 其他收益科目代码
  • 事业单位财政拨款取得方式
  • 报废过期产品怎么做会计分录
  • 简易计税项目税金要计入成本吗
  • 每股收益无差别点公式
  • 其他业务收入记账凭证怎么写
  • 计提企业年度所得税
  • 企业接受基金投资的规定
  • 房屋租赁发票在哪开
  • 所得税清算时坏账怎么算
  • 未达起征点销售额和其他免税销售额
  • 201金8税盘抵扣期限是多久?
  • 购销合同印花税按70%
  • 固定资产上的配件经常更换
  • 软件行业研发费用比例有要求么
  • 因税负低补缴上年度增值税分录怎么写?
  • 政府补贴物业公司
  • 苹果电脑型号怎么查
  • 王者荣耀中扁鹊的克星是谁
  • 季度所得税如何更正申报
  • SwiftBTN.exe - SwiftBTN是什么进程 有啥作用
  • 补缴社保操作流程
  • PHP:spl_object_hash()的用法_spl函数
  • 季节性用工政策
  • 浅谈中国式现代化3000字论文
  • 一般纳税人简易计税
  • 小规模纳税人会计分录
  • 圣诞精灵什么意思
  • 吉野是哪里
  • pdo php
  • java开发和运维
  • 工具人
  • 原生js获取document
  • 文心一格百度
  • 入侵防御部署方式
  • vue路由守卫用法
  • 政府会计公共基础设施分类
  • vue中动态添加表格
  • vue状态机
  • 同城票据交换差额户金额从哪得来的
  • 工程增值税怎么算,知道9%的税率
  • 利润表年报本期金额填什么
  • 教大家8天学通MongoDB——第一天 基础入门篇
  • 暂估入库成本需要冲销吗
  • 资产减值损失是费用吗
  • 商誉减值每年都要调整吗
  • 债券发行时发生的承销费、法律费
  • SQLSERVER 2005的ROW_NUMBER、RANK、DENSE_RANK的用法
  • 企业之间无偿使用资金涉税
  • 股东撤资后需要承担责任
  • 出口退税进项税额转出怎么申报
  • 出口抵减内销产品应纳税额在借方
  • 公司分期付款买车怎么抵税
  • 广告费属于管理费用的哪一类
  • 收到快递赔付款怎么做账
  • 维护费要交税吗
  • 新准则融资租赁承租人的会计处理
  • rapimgr.exe - rapimgr进程是什么文件.有哪些作用
  • schost.exe - schost是什么进程 有什么用
  • win8.1 ie浏览器
  • Android游戏开发打砖块
  • cocos2d schedule
  • javascript 浏览器
  • linux 压缩解压缩
  • unity3d坐标转换平面坐标代码
  • Unity3D AsssetBundle加载效率比较
  • nodejs Assert中equal(),strictEqual(),deepEqual(),strictDeepEqual()比较
  • nodejs10支持es6吗
  • math在java
  • 防伪开票系统操作流程
  • 电子发票查询官方
  • 金三是什么鱼竿?
  • 免责声明:网站部分图片文字素材来源于网络,如有侵权,请及时告知,我们会第一时间删除,谢谢! 邮箱:opceo@qq.com

    鄂ICP备2023003026号

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

    友情链接: 武汉网站建设