`

编码规范

阅读更多

<?php
妈妈咪呀php程序编码规范

1. 变量命名
    采用“驼峰式”命名,只允许由数字或字母组成,下划线是不允许的,首字母要小写,其后每个单词首字母要大写,
    变量名尽量表达详细,函数名,方法名,数组键名,都遵循此原则,
        例如:
        $userHeadThumb

   
2. 常量命名
    常量 constant 必须仅包括字母,数字和下划线,而且必须全部大写,各个单词之间用下划线分割.

        例如 :
        "MY_CONSTANT_ONE" // 是允许的
        "MYCONSTANTTWO"   // 不允许的
        "my_constant_two" // 不允许的


3.字符串
    多个字符串必须用点号 "." 来连接,且字符串与点号间必须用一个空格隔开.
   
        例如 :
        $company = 'Zend' . 'Technologies';

    变量替换中的变量 {$变量名} 的形式.

        例如 :
        $greeting = "Hello {$name}, welcome back!"; // 允许
       

    当用点号 "." 连接各字符串的时候,我们允许把它分割成多行以增强可读性.在这种情况下,点号 "." 必须与等于号 "=" 对齐.

        例如 :
        $sql = "SELECT `id`, `name` FROM `people` "
             . "WHERE `name` = 'Susan' "
             . "ORDER BY `name` ASC ";
       
       
    
4. 数组
    当使用 array 类型符声明关联数组的时候,我们鼓励把它分成多个行,同时保证每行的键与值的对齐,以保持美观,,
    数组键名命名规范和 变量命名规范一致.
        例如:
        $arrUsers = array(
                            'userId'         => 1,
                            'userName'         => '涵涵girl',
                            'userHeadThumb' => 'sweet_girl.img'
        );

       
x.  缩进
    不用tab制表符,用4个空格替代
   
    当有多行声明变量或变量赋值时,请进行等号对齐,等号右边空一格,保持好的可读性
        例如:
        $commentType    = intval($commentType);
        $userId         = intval($userId);
        $commentId      = intval($commentId);
        $posterId       = intval($posterId);

       
x.    函数
    函数名采用“驼峰式”
   
    大括号在函数名称后面,不另起一行

        例如:
        function getGirls(){
            ,,,
        }
   
    参数不易过多,否则请用数组方式传送,
   
    函数不易过大过长,过长请进行拆分
       

x. 注释
        每个函数,类 请都以下面方式注释
        /**
        *
        * 函数add,实现两个数的加法
        * 一个简单的加法计算,函数接受两个数a、b,返回他们的和c
        *
        * @param int 加数
        * @param int 被加数
        * @return integer
        *
        * author    whh
        * time         2010/10/12
        */
        function add($a, $b) {
            return $a+$b;
        }
       
        单行注释
        // ,不使用 /**/
       
        在代码编写中请尽量填写注释,需用语准确,避免含糊其辞,模棱两可,一词多义的情况


x.  类
    方法必须总是用 private,protected 或者 public 来声明其作用域.
        例如 :
        class foo{
            function goo()
            {
                // 不允许的
            }
            private function bar()
            {
                // 正确
            }
            protected function baz()
            {
                // 正确
            }
            public function zoo()
            {
                // 正确
            }
        }
       
x.  文件名
        多个单词间用下划线连接
            例如:
            add_photo.php
            ajax_add_photo.tpl
       
        此处采用“驼峰命名”是不允许的

x.  其他
   
    所有代码都必须用4个空格来进行缩进.
    在条件控制语句的条件括号内,必须用空格将操作符与其它元素隔开.如果遇到很长的逻辑判断,则鼓励用内嵌括号来分割各个逻辑.

        例如 :

        if (($a != 2) and ($b == 1)) {
            $a = $b;
        }
        foreach($arr as $param){
            ,,,
        }

        // 用 "{}" 定界内容是正确的
        if ($a != 2) {
            $a = 2;
        } else if ($a == 3) {
            $a = 4;
        } else {
            $a = 7;
        }
        // 没有用 "{}" 定界是错误的

   
    关键词 "global" 是不允许使用的,请用 $GLOBAL[xxx] 替代.

    每行代码长度应控制在80个字符以内,最长不超过120个字符.

    在一个页面,一个函数或方法内,对于$_POST,$_GET,$_REQUEST 请在第一次使用时赋值给一个变量,避免在多个地方的代码中使用它们
   
    保持开发工具的统一

分享到:
评论

相关推荐

    华为c++编码规范&c/c++安全编码规范

    华为c++编码规范和安全编码规范最新3.1版本 华为c++编码规范和安全编码规范最新3.1版本 华为c++编码规范和安全编码规范最新3.1版本 华为c++编码规范和安全编码规范最新3.1版本 华为c++编码规范和安全编码规范最新3.1...

    软件工程编码规范

    软件工程编码规范 软件工程编码规范是软件开发过程中的一种重要规范,其目的是为了确保软件的可读性、可维护性和可靠性。以下是软件工程编码规范的相关知识点: 1. 软件工程编码规范的目的 软件工程编码规范的...

    阿里Java的编码规范

    Java、编码规范、Java编码规范、阿里巴巴、阿里巴巴Java编码规范、阿里巴巴Java编码规范、阿里巴巴Java编码规范、阿里巴巴Java编码规范、阿里巴巴Java编码规范、阿里巴巴Java编码规范、阿里巴巴Java编码规范、阿里...

    阿里巴巴编码规范试题答案

    阿里巴巴编码规范试题答案 一、Java多线程编程 1. Java中的定时任务可以使用哪些方式实现?(BCDA) 答案:Java中的定时任务可以使用Timer、ScheduledExecutorService、TimerTask等方式实现。Timer可以实现简单的...

    腾讯C++编码规范

    ### 腾讯C++编码规范解读 #### 1. 概述 腾讯C++编码规范是一套由腾讯集团制定的、旨在规范公司内部C++编程风格的标准文档。该规范首次发布于2007年10月25日,目的在于确保所有使用C和C++语言开发的产品具有统一的...

    Android客户端编码规范

    ### Android客户端编码规范详解 #### 一、引言 在软件开发过程中,编码规范的制定对于提高代码质量、增强团队协作效率以及维护项目的可持续性至关重要。Android客户端编码规范旨在为开发者提供一套统一的标准,...

    c++编码规范(华为).rar

    《C++编码规范——华为实践》 在软件开发领域,编码规范是提升代码质量和团队协作效率的重要工具。尤其对于C++这种复杂的编程语言,遵循一套统一的编码规范显得尤为重要。华为作为全球知名的科技公司,其在C++编码...

    Python编码规范(Google)

    ### Python编码规范详解(基于Google风格指南) #### 一、概览 Python作为一种广泛使用的高级编程语言,其编码规范对于确保代码的可读性和一致性至关重要。Google作为业界领先的公司之一,发布了一份详细的Python...

    C# 编码规范 C# 编码规范

    C#编码规范是编程实践中的一项重要准则,旨在确保团队成员之间的一致性和代码的可读性。遵循这些规范可以提高代码质量,降低维护成本,同时也能使新加入团队的开发者更容易理解和适应现有的代码库。 1. **目的** ...

    阿里巴巴Java编码规范.pdf

    编码规范编码规范编码规范编码规范编码规范编码规范编码规范编码规范编码规范编码规范编码规范编码规范编码规范编码规范编码规范编码规范编码规范编码规范编码规范编码规范编码规范编码规范编码规范编码规范编码规范

    C语言编码规范.pdf

    C语言编码规范 C语言编码规范是编写高质量C语言代码的重要指南。遵守这些规则可以确保代码的可读性、可维护性和可靠性。本文将详细介绍C语言编码规范的各个方面,包括文件组织、命名约定、编程风格、注释、错误处理...

    阿里巴巴java编码规范

    阿里巴巴java编码规范 ,Java 并发编程培训(阿里巴巴) 《阿里巴巴Java开发手册》,首次公开阿里官方Java代码规范标准。这套Java统一规范标准将有助于提高行业编码规范化水平,帮助行业人员提高开发质量和效率、大大...

    pdf_编码规范

    编码规范

    PEP8Python 编码规范

    在Python社区中,PEP8是指导Python代码格式的官方编码规范,它对如何组织代码提供了许多建议,以确保代码的可读性和一致性。PEP8主要是针对Python代码的风格指南,其目的不是强制要求,而是为了提高代码的可读性和可...

    Vue前端编码规范.pdf

    ### Vue前端编码规范详解 #### 一、概述 在现代前端开发中,特别是使用Vue框架进行项目构建时,遵循一套合理的编码规范对于提高代码质量、维护性和团队协作效率至关重要。本文将详细介绍Vue前端项目的编码规范,...

    腾讯java编码规范

    腾讯 Java 编码规范 腾讯 Java 编码规范是腾讯集团管理标准的一部分,旨在确保公司项目代码的易维护性和编码安全性。该规范涵盖了 Java 编码风格、文件组织、代码风格、注释、命名、声明、异常、习惯等方面。 一、...

    C++ 编码规范 规范编码

    C++编码规范是确保代码质量、可读性和可维护性的关键。规范涵盖了多个方面,包括符号使用、换行、缩进、注释、标识符命名、语句使用、函数设计、类结构、程序组织和公共变量管理等。遵循这些规范可以有效提升代码的...

    JavaScript程序编码规范.pdf

    ### JavaScript程序编码规范 #### 一、概述 《JavaScript程序编码规范》是一份旨在提高JavaScript代码质量和可维护性的指南。该规范由Douglas Crockford编写,并由cloudwater翻译成中文版。Crockford是一位著名的...

    华为JAVA编码规范.pdf

    华为JAVA编码规范.pdf 华为JAVA编码规范.pdf是华为公司编写的JAVA编程语言编码规范,旨在提供一个统一的编程风格和代码组织方式,以提高代码的可读性、维护性和可重用性。该规范涵盖了编程语言的基本结构、命名规则...

    华为Java语言编码规范.doc

    华为Java语言编码规范.doc 本文档介绍了华为Java语言编程规范的相关知识点,涵盖编程规范、命名规范、注释规范、编码规范、JTEST规则等内容。 1. 编程规范 编程规范是指在编程时必须遵守的原则,旨在确保代码的...

Global site tag (gtag.js) - Google Analytics