Heim  >  Artikel  >  Backend-Entwicklung  >  PHP代码样式

PHP代码样式

巴扎黑
巴扎黑Original
2016-11-23 15:19:281439Durchsuche

如果使用第三方框架,并且有提供代码样式说明,则遵循其代码样式标准,否则如下! 

== 格式: 

* 使用UTF-8编码 

* 使用4个空格缩进,禁止使用Tab 

* Unix样式换行符(LF) 

* 在逗号、冒号和分号操作符使用空格 

* 在 (,[ 后面、],) 前面不使用空格 

* 在代码块中使用4个空格缩进 

* 采用层级缩进 

* 在return方法的返回值前使用空行(除非只有一行代码)以及在两个方法中使用空行区分 

* 在两个大的逻辑代码段之间使用空行区分 

* 保持行字数在80字以内,最多不超过120 

* 使用标准的PHP标签定界,禁止使用短标签(ab90e1b15fa9bd92a0def3a269726396),对于只包含有PHP代码的文 
件,禁止使用PHP结束标志("?>"),文件末尾使用注释说明"/* End of file 13fa444ed9b39e3119e4048c8bd4bc35 */" 

* 单行代码也必须使用分号(;)结束 

== 命名: 

* 文件名使用snake_case方式,禁止使用臃肿的文件名 

* 变量名使用snake_case方式,禁止使用臃肿的变量名 
  * 禁止使用单字符做为局部变量(如$i),在for循环中除外 
  * 禁止使用大写字母做为全局变量,如使用大写字母,应使用SCREAMING_SNAKE_CASE方式 

* 类名使用CamelCase方式,方法名使用camelCase方式(保持像HTTP,RFC,XML缩写词的大写) 

* 常量名使用SCREAMING_SNAKE_CASE方式 

// bad
superclass.php
SuperClass.php
superClass.php
$i = "foobar";  // 单字符变量只充许使用在for循环中
$bufferdText   // 驼峰式变量,并且意思可以再精简些
$groupid        // 两个单词之间需要下划线分开
$name_of_last_city_used // 太长
MyConstant       // 应该用下划线并且字母没有全大写
N                     // 单字符
S_C_VER           // 意思不清楚
class superclass
class superClass
function fileproperties() // 意思不清楚并且没有驼峰式命名
function fileProperties() // 意思不清楚
function getfileproperties() // 好些了,但没有驼峰式命名
// good
super_class.php
for ($i = 0; $i < 10; $i++)
$buffer
$group_id
$last_city
MY_CONSTANT
NEWLINE
SUPER_CLASS_VERSION
class SuperClass
function getFileProperties()

== 语法: 

对于嵌入HTML中的PHP代码,对于像if, for, foreach, while等代码块,采用if: ... endif; for: ... endfor; foreach: ... endforeach;以及 while: ... endwhile;方法块 

Php代码  

...  

6ba01827646606b80920f8b7eadc8ff2isLoggedIn()): // checking logged in ?>  

4a5316b26dfa045c1c36eec6b2882c7c  

660918524d886f8e28629fe181a391a2  

  

c3b8fed163514348dd19b216cade18fa  

4a5316b26dfa045c1c36eec6b2882c7c  

362266facacad7e6e4c4f68227427a68  

...  



== 注释: 

* 文档块必须和phpDocumentor格式兼容,请参考: http://phpdoc.org/ 

* 避免多余的意见 

Php代码  

/** 

 * 控制器类说明信息 

 */  

class Controller {  

    private static $instance;  

  

    public function __construct()  {  

        ...  

    }  

  

    /** 

     * 函数说明信息 

     */  

    public static function &get_instance() {  

        ...  

    }  

  

/* End of file controller.php */  



== 其他: 

* 保持代码简单 

* 保持一致性 


Stellungnahme:
Der Inhalt dieses Artikels wird freiwillig von Internetnutzern beigesteuert und das Urheberrecht liegt beim ursprünglichen Autor. Diese Website übernimmt keine entsprechende rechtliche Verantwortung. Wenn Sie Inhalte finden, bei denen der Verdacht eines Plagiats oder einer Rechtsverletzung besteht, wenden Sie sich bitte an admin@php.cn