服务器之家:专注于服务器技术及软件下载分享
分类导航

PHP教程|ASP.NET教程|JAVA教程|ASP教程|

服务器之家 - 编程语言 - PHP教程 - PHP编码规范之注释和文件结构说明

PHP编码规范之注释和文件结构说明

2019-11-04 13:28php教程网 PHP教程

理解学习PHP编码规范之注释和文件结构,编写规则的代码与目录结构让大家能快速的熟悉。提高协同工作效率。

文件结构 

|――images 
|――include 
  |――parameter 
  |――config 
  |――function 
|――index 
images存放图片文件,include中是系统是要引用的文件,一般在parameter中存放参数文件,config中存放配置文件,function中存放方法文件,如javascript的方法等,并按功能模块的分类,将各功能的类也放入其中 
文件名 
文件夹命名一般采用英文,长度一般不超过20个字符,命名采用小写字母。除特殊情况才使用中文拼音,一些常见的文件夹命名如:images(存放图形文件),flash(存放Flash文件),style(存放CSS文件),scripts(存放Javascript脚本),inc(存放include文件),link(存放友情链接),media(存放多媒体文件)等。文件名称统一用小写的英文字母、数字和下划线的组合。 
注释 
块注释通常用于提供对文件,方法,数据结构和算法的描述。块注释被置于每个文件的开始处以及每个方法之前。它们也可以被用于其他地方,比如方法内部。在功能和方法内部的块注释应该和它们所描述的代码具有一样的缩进格式。 
块注释之首应该有一个空行,用于把块注释和代码分割开来,比如: 
/* 
 * 这里是块注释 
*/ 
块注释可以以/*-开头,这样indent(1)就可以将之识别为一个代码块的开始,而不会重排它。 
/*- 
 * 如果想被忽略,可是使用特别格式的块注释 
 * 
 * one 
 *   two 
 *     three 
 */ 
注意:如果你不使用indent(1),就不必在代码中使用/*-,或为他人可能对你的代码运行indent(1)作让步。 
单行注释 
短注释可以显示在一行内,并与其后的代码具有一样的缩进层级。如果一个注释不能在一行内写完,就该采用块注释。单行注释之前应该有一个空行。以下是一个代码中单行注释的例子: 
if (condition) { 
  /* 以下代码运行的条件 */ 
  ... 

尾端注释 
极短的注释可以与它们所要描述的代码位于同一行,但是应该有足够的空白来分开代码和注释。若有多个短注释出现于大段代码中,它们应该具有相同的缩进。 
以下是一个代码中尾端注释的例子: 

复制代码代码如下:


if ($a == 2) { 
  return TRUE; /* 对单一条件的说明 */ 
} else { 
  return isPrime($a); /* 其余的条件 */ 


行末注释 
注释界定符"//",可以注释掉整行或者一行中的一部分。它一般不用于连续多行的注释文本;然而,它可以用来注释掉连续多行的代码段。以下是所有三种风格的例子: 

复制代码代码如下:


if ($foo > 1) { 
  // 第二种用法. 
  ... 

else { 
  return false; // 说明返回值的原因 

//if ($bar > 1) { 
// 
//  // 第三种用法 
//  ... 
//} 
//else { 
  // return false; 
//} 


文档注释 
文档注释描述php的类、构造器,方法,以及字段(field)。每个文档注释都会被置于注释定界符/**...*/之中,一个注释对应一个类或成员。该注释应位于声明之前: 

/** 
 * 说明这个类的一些 ... 
*/ 
class Example { ... 

注意顶层(top-level)的类是不缩进的,而其成员是缩进的。描述类的文档注释的第一行(/**)不需缩进;随后的文档注释每行都缩进1格(使星号纵向对齐)。成员,包括构造函数在内,其文档注释的第一行缩进4格,随后每行都缩进5格。 
若你想给出有关类、变量或方法的信息,而这些信息又不适合写在文档中,则可使用实现块注释(见5.1.1)或紧跟在声明后面的单行注释(见5.1.2)。例如,有关一个类实现的细节,应放入紧跟在类声明后面的实现块注释中,而不是放在文档注释中。 
文档注释不能放在一个方法或构造器的定义块中,因为程序会将位于文档注释之后的第一个声明与其相关联。

延伸 · 阅读

精彩推荐
  • PHP教程php ftp文件上传函数(基础版)

    php ftp文件上传函数(基础版)

    很多时间我们不会用于php ftp函数文件上传,但有在使用比较高级的WEB应用时就会用到关于ftp功能,如我现在要把上传的图片传B服务器,数据保存到A服务器...

    php教程网3842019-10-31
  • PHP教程PHP设计模式之状态模式定义与用法详解

    PHP设计模式之状态模式定义与用法详解

    这篇文章主要介绍了PHP设计模式之状态模式定义与用法,结合实例形式分析了php状态模式的概念、原理、定义、使用方法及相关注意事项,需要的朋友可以参...

    雪山飞猪3322019-10-14
  • PHP教程php JWT在web端中的使用方法教程

    php JWT在web端中的使用方法教程

    这篇文章主要给大家介绍了关于php JWT在web端中的使用方法,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋...

    soledad2552019-09-08
  • PHP教程PHP微信H5支付开发实例

    PHP微信H5支付开发实例

    这篇文章主要为大家详细介绍了PHP微信H5支付开发实例,具有一定的参考价值,感兴趣的小伙伴们可以参考一下 ...

    袁威2392019-09-18
  • PHP教程PHP JSON 数据解析代码

    PHP JSON 数据解析代码

    PHP解析JSON 数据代码,与大多数流行的 Web 服务如 twitter 、人人网通过开放 API 来提供数据一样,它总是能够知道如何解析 API 数据的各种传送格式,包括 ...

    php教程网4212019-10-30
  • PHP教程PHP 获取视频时长的实例代码

    PHP 获取视频时长的实例代码

    本文通过实例代码给大家介绍了php获取视频时长的相关知识,非常不错,具有一定的参考借鉴价值,需要的朋友参考下吧 ...

    清风带酒2532019-09-20
  • PHP教程Laravel框架实现超简单的分页效果示例

    Laravel框架实现超简单的分页效果示例

    这篇文章主要介绍了Laravel框架实现超简单的分页效果,结合实例形式分析了Laravel框架实现分页功能的相关控制器、视图、模板调用等相关操作技巧,需要的朋...

    cofecode4002019-06-18
  • PHP教程PHP实现对图片的反色处理功能【测试可用】

    PHP实现对图片的反色处理功能【测试可用】

    这篇文章主要介绍了PHP实现对图片的反色处理功能,涉及php针对图片的读取、数值运算等相关操作技巧,需要的朋友可以参考下 ...

    咸鱼韭菜1412019-10-23