PHP團隊 編碼規範 & 代碼樣式風格規範

來源:互聯網
上載者:User
一、基本約定 1、源檔案

(1)、純PHP代碼源檔案只使用 <?php 標籤,省略關閉標籤 ?> ;

(2)、源檔案中PHP代碼的編碼格式必須是無BOM的UTF-8格式;

(3)、使用 Unix LF(分行符號)作為行結束符;

(4)、一個源檔案只做一種類型的聲明,即,這個檔案專門用來聲明Class, 那個檔案專門用來設定配置資訊,別混在一起寫; 2、縮排

使用Tab鍵來縮排,每個Tab鍵長度設定為4個空格; 3、行

一行推薦的是最多寫120個字元,多於這個字元就應該換行了,一般的編輯器是可以設定的。 4、關鍵字 和 True/False/Null

PHP的關鍵字,必須小寫,boolean值:true,false,null 也必須小寫。

下面是PHP的“關鍵字”,必須小寫:

'__halt_compiler', 'abstract', 'and', 'array', 'as', 'break', 'callable', 'case', 'catch', 'class', 'clone', 'const', 'continue', 'declare', 'default', 'die', 'do', 'echo', 'else', 'elseif', 'empty', 'enddeclare', 'endfor', 'endforeach', 'endif', 'endswitch', 'endwhile', 'eval', 'exit', 'extends', 'final', 'for', 'foreach', 'function', 'global', 'goto', 'if', 'implements', 'include', 'include_once', 'instanceof', 'insteadof', 'interface', 'isset', 'list', 'namespace', 'new', 'or', 'print', 'private', 'protected', 'public', 'require', 'require_once', 'return', 'static', 'switch', 'throw', 'trait', 'try', 'unset', 'use', 'var', 'while', 'xor' 5、命名

(1)、類名 使用大駝峰式(StudlyCaps)寫法;

(2)、(類的)方法名 使用小駝峰(cameCase)寫法;

(3)、函數名使用 小寫字母 + 底線 寫法,如 function http_send_post(); 

(4)、變數名 使用小駝峰寫法,如 $userName; 6、代碼注釋標籤

如 函數注釋、變數注釋等,常用標籤有 @package、@var、@param、@return、@author、@todo、@throws

必須遵守 phpDocument 標籤規則,不要另外去創造新的標籤,更多標籤查看 phpDocument官網 7、業務模組

(1)、涉及到多個資料表 更新/添加 操作時,最外層要用事務,保證資料庫操作的原子性;

(2)、Model層,只做簡單的資料表的查詢;

(3)、商務邏輯統一封裝到 Logic層;

(4)、控制器只做URL路由,不要當作 業務方法 調用;

(5)、控制器層不能出現SQL動作陳述式,如 ThinkPHP架構的 where()、order() 等模型方法,

即,控制器中,不要出現類似這樣的SQL語句:D('XXX')->where()->order()->limit()->find();  

where()、order()、limit() 等SQL方法只能出現在 Model層、業務層。 二、代碼樣式風格 1、命名空間(Namespace) 和 匯入(Use)聲明

先簡單文字描述下: 命名空間(namespace)的聲明後面必須有一行空行; 所有的匯入(use)聲明必須放在命名空間(namespace)聲明的下面; 一句聲明中,必須只有一個匯入(use)關鍵字; 在匯入(use)聲明代碼塊後面必須有一行空行;

用代碼來說明下:

1 2 3 4 5 6 <?php namespace  Lib\Databases;  // 下面必須空格一行   class  Mysql {   }

namespace下空一行,才能使用use,再空一行,才能聲明class

1
相關文章

聯繫我們

該頁面正文內容均來源於網絡整理,並不代表阿里雲官方的觀點,該頁面所提到的產品和服務也與阿里云無關,如果該頁面內容對您造成了困擾,歡迎寫郵件給我們,收到郵件我們將在5個工作日內處理。

如果您發現本社區中有涉嫌抄襲的內容,歡迎發送郵件至: info-contact@alibabacloud.com 進行舉報並提供相關證據,工作人員會在 5 個工作天內聯絡您,一經查實,本站將立刻刪除涉嫌侵權內容。

A Free Trial That Lets You Build Big!

Start building with 50+ products and up to 12 months usage for Elastic Compute Service

  • Sales Support

    1 on 1 presale consultation

  • After-Sales Support

    24/7 Technical Support 6 Free Tickets per Quarter Faster Response

  • Alibaba Cloud offers highly flexible support services tailored to meet your exact needs.