基本規(guī)范

2018-10-19 16:59 更新

需要遵守的編碼規(guī)范

PSR-4依賴于自動(dòng)加載,而自動(dòng)加載又依賴項(xiàng)目目錄結(jié)構(gòu)。
為了更好的使用我們的自動(dòng)加載機(jī)制,也為了代碼的易讀、規(guī)范化,作者簡(jiǎn)明扼要的講一下在使用Idea框架時(shí),必須要遵守的一些編碼規(guī)范。

Lniux系統(tǒng)與Windows系統(tǒng)開發(fā)的區(qū)別

  1. Windows不區(qū)分大小寫,Linux嚴(yán)格區(qū)分大小寫。

    在默認(rèn)情況下,我建議同學(xué)們注意編碼規(guī)范,平時(shí)編碼有個(gè)習(xí)慣,所有代碼都嚴(yán)格區(qū)分大小寫。

  2. 分隔符,Linux使用'/',Windows使用'/'與'\',所以我們統(tǒng)一使用'/'或者使用PHP內(nèi)置常量DIRECTORY_SEPARATOR來表示

1. 目錄和文件

  • 目錄全部小寫,PHP文件(入口文件除外)使用帕斯卡(大駝峰)命名法。
  • 靜態(tài)文件命名無嚴(yán)格要求。

2.類的規(guī)范

  • 類名使用使用帕斯卡(大駝峰)命名法。直接以后綴.php結(jié)尾,無需以使用xxx.class.php結(jié)尾。

  • 所有控制器類無需繼承控制器基類(因?yàn)榭蚣軟]有定義基類),且控制器類必須放置在應(yīng)用目錄/模塊目錄/controller下面。
    例:application/admin/controller/Common.php

<?php
namespace app\admin\controller;


class Common
{
}
  • 所有模型類必須繼承模型基類\system\Model,且模型類必須放置在應(yīng)用目錄/模塊目錄/model下面。
    例:application/admin/model/User.php
<?php
namespace app\admin\model;

use \system\Model;


class User extends Model
{
}

3.函數(shù)與方法(函數(shù)方法推薦小駝峰)

  • 方法名使用小駝峰命名法或者以下劃線“_”分隔
//PSR-2規(guī)范
public static function getName()
{
}

4.變量和常量(變量推薦下劃線分割,與函數(shù)方法區(qū)分)

  • 變量或參數(shù)使用駱駝命名法或者以下劃線“_”分隔,
    例如:
$user_name='張三';
$userName='張三';
  • 常量必須全部大寫,單詞之間以下劃線“_”分隔,
    例如:
define('APP_NAME','bbs');

一個(gè)完整的模型類設(shè)計(jì)如下:

例:application/admin/model/User.php

<?php
namespace app\admin\model;

use system\Model;


class User extends Model
{
    public function userList()
    {
        #code...
    }
}
以上內(nèi)容是否對(duì)您有幫助:
在線筆記
App下載
App下載

掃描二維碼

下載編程獅App

公眾號(hào)
微信公眾號(hào)

編程獅公眾號(hào)