PHP编码规范实例

<?php
  /**
  * 符合psr-1,2的编程实例
  *
  * @author 作者 描述
  */
   
  namespace Standard; // 顶部命名空间
  // 空一行
  use Test\TestClass;//use引入类
   
  /**
  * 类描述
  *
  * 类名必须大写开头驼峰.
  */
  abstract class StandardExample // {}必须换行
  {
    /**
    * 常量描述.
    *
    * @var string
    */
    const THIS_IS_A_CONST = ‘‘; // 常量全部大写下划线分割
   
    /**
    * 属性描述.
    *
    * @var string
    */
    public $nameTest = ‘‘; // 属性名称建议开头小写驼峰
    // 成员属性必须添加public(不能省略), private, protected修饰符
   
    /**
    * 属性描述.
    *
    * @var string
    */
    private $_privateNameTest = ‘‘; // 类私有成员属性,【个人建议】下划线小写开头驼峰
   
    /**
    * 构造函数.
    *
    * 构造函数描述
    *
    * @param string $value 形参名称/描述
    */
    public function __construct($value = ‘‘)// 成员方法必须添加public(不能省略), private, protected修饰符
    {// {}必须换行
   
      $this->nameTest = new TestClass();
   
      // 链式操作
      $this->nameTest->functionOne()
              ->functionTwo()
              ->functionThree();
   
      // 一段代码逻辑执行完毕 换行
      // code...
    }
   
    /**
    * 成员方法名称.
    *
    * 成员方法描述
    *
    * @param string $value 形参名称/描述
    *
    * @return 返回值类型 返回值描述
    * 返回值类型:string,array,object,mixed(多种,不确定的),void(无返回值)
    */
    public function testFunction($value = ‘‘)// 成员方法必须小写开头驼峰
    {
      // code...
    }
   
    /**
    * 成员方法名称.
    *
    * 成员方法描述
    *
    * @param string $value 形参名称/描述
    *
    * @return 返回值类型 返回值描述
    */
    private function _privateTestFunction($value = ‘‘)// 私有成员方法【个人建议】下划线小写开头驼峰
    {
      // code...
    }
   
    /**
    * 成员方法名称.
    *
    * 成员方法描述
    *
    * @param string $value 形参名称/描述
    *
    * @return 返回值类型 返回值描述
    */
    public static function staticFunction($value = ‘‘)// static位于修饰符之后
    {
      // code...
    }
   
    /**
    * 成员方法名称.
    *
    * 成员方法描述
    *
    * @param string $value 形参名称/描述
    *
    * @return 返回值类型 返回值描述
    */
    abstract public function abstractFunction($value = ‘‘); // abstract位于修饰符之前
   
    /**
    * 成员方法名称.
    *
    * 成员方法描述
    *
    * @param string $value 形参名称/描述
    *
    * @return 返回值类型 返回值描述
    */
    final public function finalFunction($value = ‘‘)// final位于修饰符之前
    {
      // code...
    }
   
    /**
    * 成员方法名称.
    *
    * 成员方法描述
    *
    * @param string $valueOne 形参名称/描述
    * @param string $valueTwo 形参名称/描述
    * @param string $valueThree 形参名称/描述
    * @param string $valueFour 形参名称/描述
    * @param string $valueFive 形参名称/描述
    * @param string $valueSix 形参名称/描述
    *
    * @return 返回值类型 返回值描述
    */
    public function tooLangFunction(
      $valueOne = ‘‘, // 变量命名可小写开头驼峰或者下划线命名,个人那习惯,据说下划线可读性好
      $valueTwo = ‘‘,
      $valueThree = ‘‘,
      $valueFour = ‘‘,
      $valueFive = ‘‘,
      $valueSix = ‘‘)// 参数过多换行
    {
      if ($valueOne === $valueTwo) {// 控制结构=>后加空格,同{一行,(右边和)左边不加空格
        // code...
      }
   
      switch ($valueThree) {
        case ‘value‘:
          // code...
          break;
   
        default:
          // code...
          break;
      }
   
      do {
        // code...
      } while ($valueFour <= 10);
   
      while ($valueFive <= 10) {
        // code...
      }
   
      for ($i = 0; $i < $valueSix; $i++) {
        // code...
      }
    }
  }
时间: 2024-08-01 22:45:01

PHP编码规范实例的相关文章

java编码规范

右括号") "与其后面的关键字之间,关键字与其后面的左括号"("或"{"之间,以及"}"与"{"之间,要以一个空格隔开:除". "外,所有二元操作符的前.后要加空格:在逗号后边加一个空格. 说明: 一个紧跟着括号的关键词应该被空格分开: 空白应该位于参数列表中逗号的后面: 所有的二元运算符,除了".",应该使用空格将之与操作数分开.一元操作符和操作数之间不应该加空格,

我也学php:编码规范/翻译自PSR

PHP社区百花齐放,拥有大量的函数库.框架和组件.PHP开发者通常会在自己的项目中使用若干个外部库,因而PHP代码遵循或尽量接近同一个代码风格就非常重要,可以让开发者方便地把多个代码库集成在自己的项目中. 框架互操作组(即PHP标准组)发布了一系列代码风格推荐标准,即PSR-0,PSR-1,PSR-2和PSR-3. 不要让这些名称所混淆,这些推荐仅是一些被其它项目所遵循的规则,如Drupal, Zend, Symfony, CakePHP, phpBB, AWS SDK, FuelPHP, Li

【转】Airbnb React编码规范

Airbnb的编码规范是在业界非常流行的一套规范,而且它一直都在进化,推出最新技术的规范 原文:https://zhuanlan.zhihu.com/p/20616464 用更合理的方式书写React和JSX 基本规则 每个文件只包含一个React组件: 但是无状态, 或者 Pure 组件 允许一个文件包含多个组件.eslint: react/no-multi-comp. 始终使用 JSX 语法; 不要使用 React.createElement方法,除非初始化 app 的文件不是 JSX 格式

Bootstrap编码规范

黄金定律 永远遵循同一套编码规范 -- 可以是这里列出的,也可以是你自己总结的.如果你发现本规范中有任何错误,敬请指正.通过 open an issue on GitHub为本规范添加或贡献内容. 不管有多少人共同参与同一项目,一定要确保每一行代码都像是同一个人编写的. HTML 语法 用两个空格来代替制表符(tab) -- 这是唯一能保证在所有环境下获得一致展现的方法. 嵌套元素应当缩进一次(即两个空格). 对于属性的定义,确保全部使用双引号,绝不要使用单引号. 不要在自闭合(self-clo

iOS:Cocoa编码规范 -[译]Coding Guidelines for Cocoa

--原文地址:https://developer.apple.com/library/mac/documentation/Cocoa/Conceptual/CodingGuidelines/Articles/FrameworkImpl.html Cocoa编码规范 --前言 用公共API开发一个Cocoa框架,插件,或其他可执行目标,里面的命名编写和规范不同于一般应用程序的开发.因为你开发出来东西是给开发者用的看的,并且他们不熟悉你的编程接口.这个时候API的命名约定就派上用场了,因为它使你的写

说说Python编码规范

前言 已有近两个月没有发表过文章了,前段时间外甥和女儿过来这边渡暑假,平常晚上和周末时间都陪着她们了,趁这个周末有空,再抽空再把这块拾起来.         这么久没写了,再次拿起键盘,想想,发表些什么呢,想起上次公司的代码评审委员会下周其中一个议题是关于Python编码规范的整理,那就趁热打铁,整理一份关于Python编码规范的文章,也为那些写Python的人,提供一些编码注意的一些事项或者说是参考吧. 编码规范的作用         规范故明思义,就是通过不断的总结,吸取好的点,从而形成的一

Android 编码规范

编码规范对于程序员而言,尤为重要,有以下几个原因: 一个软件的生命周期中,80%的花费在于维护: 几乎没有任何一个软件,在其整个生命周期中,均由最初的开发来维护: 编码规范可以改善软件的可读性,可以让程序员尽快而彻底地理解新的代码: 如果你将源码作为产品发布,就需要确认它是否被很好的打包并且清晰无误,一如你已构建的其他任何产品: 命名 1.包命名 包名规则:一个唯一的包名的前缀总是全部小写的ASCII字母并且是一个顶级域名,如com.edu.gov.net.org等.包名的后续部分根据不同机构各

web项目开发 之 前端规范 --- JavaScript编码规范

JavaScript编码规范 此文严格按照W3C规范和部分实际项目可读性,浏览器加载,性能等众多属性权衡,做出平时前端编码规范文档.供广大web工作者参考并实施,对维护和项目扩展升级都能省时省力. 场景:web前端开发中 一些Javascript的注意事项 和 规格建议: [参考百度资料 和个人一些总结] 1 前言 JavaScript 在百度一直有着广泛的应用,特别是在浏览器端的行为管理.本文档的目标是使 JavaScript 代码风格保持一致,容易被理解和被维护. 虽然本文档是针对 Java

编码规范的作用

编码规范是实施质量保证的第一步,是提高我们代码质量的有效工具之一. 编码规范的作用. (1)提高可读性 编码规范,帮助我们写出人类容易理解的代码,它为我们提供了最基本的模板,良好的编码风格,使代码具           有一定的描述性,可以通过名字来获取一些需要IDE才能得到的提示,如可访问性.继承基类等. (2)统领全局,促进团队协助 编码规范,要求团队成员遵守这一统一的全局决策,这样成员之间可以轻松地阅读对方的代码,所有成员正以一种清         晰而一致的风格进行编码.而且,开发人员也