Laravel框架开发规范-修订版
1.PHP編碼規(guī)范
1.1 標(biāo)簽
PHP 程序可以使用<?php ?>或<?= ?>來(lái)界定PHP代碼
在HTML 頁(yè)面中嵌入純變量時(shí),使用<?= ?>這樣的形式
純PHP類(lèi)文件,文件開(kāi)始標(biāo)簽使用<?php,閉合標(biāo)簽?>必須省略
1.2 編碼
PHP文件必須使用無(wú)BOM的UTF-8編碼方式
1.3 注釋
單行注釋:在語(yǔ)句后面使用“//”注釋
多行注釋:如下,注意換行
文件注釋 /*** 描述** @copyright Copyright© 2016, 公司名稱(chēng)* @author zongshuai* @Date: 16/7/15* @Time: 下午5:45*/方法或者函數(shù)注釋 /*** 描述** @param 類(lèi)型 $fields 描述* @param 類(lèi)型 $fields 描述* @return 類(lèi)型 描述*/屬性注釋 /** * 描述 * * @var 類(lèi)型 */1.4 命名規(guī)則
類(lèi):文件名和類(lèi)名必須一致,切采用首字母大寫(xiě)的駝峰命名法
函數(shù)和方法:采用首字母小寫(xiě)的駝峰命名法,盡量用有意義,描述性的詞語(yǔ)來(lái)命名,用checkForErrors()代替errorCheck(),用dumpDataToFile()代替dataFile()。
變量名:
用有意義的,描述性的詞語(yǔ)來(lái)命名變量
別用縮寫(xiě)。用name, address, salary 等代替 nam, addr, sal 全局變量以”g_” 開(kāi)頭
別使用單個(gè)字母的變量象i, n, x 等. 使用 index, temp 等
和前端交互的變量名全部用小寫(xiě)加下劃線(xiàn)命名
常量名:全部使用大寫(xiě)字母和下滑線(xiàn)組成,常量的名稱(chēng)中不允許出現(xiàn)小寫(xiě)字母,可使用分隔符作為下劃線(xiàn)
1.5 書(shū)寫(xiě)規(guī)則
所有 PHP 文件必須以一個(gè)空行結(jié)束
行實(shí)際長(zhǎng)度不應(yīng)超過(guò) 80 個(gè)字符;較長(zhǎng)的行應(yīng)當(dāng)被拆分成多個(gè)不超過(guò)80 個(gè)字符的后續(xù)行。
空行可以用來(lái)改善可讀性和區(qū)分相關(guān)的代碼塊
一行不應(yīng)多于一個(gè)語(yǔ)句
每個(gè)縮進(jìn)的單位約定是4 個(gè)空格的縮進(jìn),并且不可使用制表符作為縮進(jìn),建議使用PhpStrom編輯器
每個(gè)運(yùn)算符與兩邊參與運(yùn)算的值或表達(dá)式中間要有一個(gè)空格
在絕大多數(shù)可以使用單引號(hào)的場(chǎng)合,禁止使用雙引號(hào)(性能考慮)
PHP所有關(guān)鍵字必須全部小寫(xiě)。常量?true?、false?和?null?也?必須?全部小寫(xiě)
類(lèi)的開(kāi)始花括號(hào)({)?必須?寫(xiě)在函數(shù)聲明后自成一行,結(jié)束花括號(hào)(})也?必須?寫(xiě)在函數(shù)主體后自成一行
方法的開(kāi)始花括號(hào)({)?必須?寫(xiě)在函數(shù)聲明后自成一行,結(jié)束花括號(hào)(})也?必須?寫(xiě)在函數(shù)主體后自成一行
方法名在聲明之后不可跟隨一個(gè)空格。左括號(hào)后面不可有空格,右括號(hào)前面不可有空格
關(guān)鍵詞?extends?和?implements?必須?寫(xiě)在類(lèi)名稱(chēng)的同一行。implements?的繼承列表也?可以?分成多行,這樣的話(huà),每個(gè)繼承接口名稱(chēng)都?必須?分開(kāi)獨(dú)立成行,包括第一個(gè)
類(lèi)的屬性和方法?必須?添加訪(fǎng)問(wèn)修飾符(private、protected?以及?public),abstract?以及final?必須?聲明在訪(fǎng)問(wèn)修飾符之前
而?static?必須?聲明在訪(fǎng)問(wèn)修飾符之后
如果存在abstract 和final 聲明必須放在可見(jiàn)性聲明前面
一定不可?使用關(guān)鍵字?var?聲明一個(gè)屬性。
每條語(yǔ)句?一定不可?定義超過(guò)一個(gè)屬性
在參數(shù)列表中,逗號(hào)之前不可有空格,逗號(hào)之后必須要有一個(gè)空格
方法中有默認(rèn)值的參數(shù)必須放在參數(shù)列表的最后面
參數(shù)列表可以被分為多個(gè)有一次縮進(jìn)的多個(gè)后續(xù)行。如果這么做,列表的第一項(xiàng)必須放在下一行,并且每行必須只放一個(gè)參數(shù)。
當(dāng)參數(shù)列表被分為多行,右括號(hào)和左花括號(hào)必須夾帶一個(gè)空格放在一起自成一行。
2.數(shù)據(jù)庫(kù)命名規(guī)范
2.1命名規(guī)范
?
轉(zhuǎn)載于:https://www.cnblogs.com/xiaozong/p/5811535.html
總結(jié)
以上是生活随笔為你收集整理的Laravel框架开发规范-修订版的全部?jī)?nèi)容,希望文章能夠幫你解決所遇到的問(wèn)題。
- 上一篇: 计算机专业考研入坑详解(持续更新)
- 下一篇: HDU-4089 Activation