2023-11-07 分類: 網站建設
我們為什么要培養自己的編碼標準?
當我們編寫代碼時,一個好的編碼標準可以給我們帶來很多意想不到的效果。至少有以下好處:
1、提高我們的編碼效率。整齊統一的代碼方便我們復制粘貼!
2、提高代碼可讀性。
3、展示我們的專業知識。別人看了我們的代碼,發現整個代碼的編寫過程整齊劃一,瞬間就上去了!
4、便于團隊合作。大家都用同一個規范,這樣就省去了各種寫法,協調一致!
編碼規范由代碼規范和注釋規范兩大塊組成
其實我們寫的php腳本其實是由兩部分組成,分別是代碼的編寫和代碼的注解!不同的框架,甚至不同的公司,在這方面都會有不同的看法。這就是剛才所說的,只是對自己的寫作規范的一個總結!希望對其他朋友有所啟發
1、代碼編寫規范
文件夾命名:
對同一文件夾使用小寫字母。比如存放控制器的文件夾可以直接命名為
文件命名:
如果是文件,那么文件的命名要保持同名一致,統一使用大駝峰大小寫。如..php,對應的類名是,
如果是常用的工具腳本,那么統一使用小駝峰案例,比如.php
類名的命名:
同類名使用大駝峰,類
方法名命名:
統一使用小駝峰格,一般用動詞+秩的形式來描述方法的功能,比如發送短信。
在面向對象中,遵循相同的規則,但有一些不同:
public getUserName() protected _getTotalAmount() private _setblanceAmount()
變量命名約定:
關于變量,我們需要多說幾句:
1、無論是面向對象還是非面向對象的語法網站建設,變量都統一使用小駝峰式,如:$。
但是在面向對象中就不一樣了,當 , , , 或屬性前加 _ 作為區分
public $startposition = 1; protected $_salaryAmount =1000; private $_sex = 'formale';
2、如果是常量,統一使用大寫,下劃線分隔。
define('CURRENT_SCRIpT', 'index.php'); const TRANSACTION_TYpE = 'income';
3、全局變量,大駝峰大小寫,前綴_,所有單詞首字母大寫。因為知道變量的作用域很重要,所以局部變量和全局變量要分清楚!
$;
$;
縮進
關于編碼的縮進,我們統一使用制表符縮進!有人可能會問,為什么空格縮進不適用?
原因很簡單php 代碼混淆,大部分編輯器都支持制表符等于多少個空格,使用空格不是必須的!
計算符號
所有二元運算符都應該在前面和前面加空格
$name = 'zero'; $age > 18 ? 'adult' : 'children';
通用過程報表規劃
我們同意所有流程語句的大括號都在單獨的行上。原因:如果遇到比較復雜的業務邏輯,會有很多花括號的嵌套,所以我們會混淆對應的花括號!
1、分支聲明
if($age >= 18 && $age <= 30) { echo 'young man'; } else if($age > 30 && $age <= 60) { echo 'middle aged'; } else { echo 'old man'; } //下面這段代碼高手我們一個問題,在if語句中,即使在可以不要花括號的情況下,花括號也是要寫上的 if($age > 60) { echo 'I am very old'; } switch($status) { case 'forbiden': echo 'login forbidden'; break; case 'normal': echo 'login in'; break; default: echo 'status is wrong' : break; }
2、循環語句
while($condition) { statesments......; } foreach($arrayList as $arrayKey => $arrayItem) { states......; } do { statements......; } while($condition) for($start; condition; changenumber) { statements......; }
2、評論書寫規范
很多人說好的代碼不需要注釋。其實我個人認為這是一句廢話(或許他是對的php 代碼混淆,除非他是整個團隊中唯一的一個,他什么都做,不需要看別人的代碼)。
個人觀點是:多寫點評論,不管是對團隊其他人還是自己,都很友好!
根據個人經驗,注解至少有以下功能:
1、有助于提高代碼的可讀性,畢竟看你的評論比看你的代碼容易多了!
2、非常適合規劃自己的代碼布局!這樣做的原因是因為它與代碼注釋的類型有關?!坝欣诖a的布局”,這種東西好像有點懸,光說是看不懂,需要實例來支持!
3、因為我們的注解規范是符合要求的,所以這個工具還可以生成代碼的大致描述,相當于一本說明書!
代碼注釋的類型
1、屏蔽評論
塊評論,我覺得主要用在三個地方。php腳本的描述,一個大功能模塊的描述,當注釋不能寫在一行的時候,也應該放在塊注釋中
2、行評論
行評論,我個人認為他與塊評論一起工作!一般用來描述一個大功能模塊的具體細節!
實際案例
關于語法的具體使用細節,這里就不多說了。官網說的再清楚不過了。
從上面的例子可以看出代碼的布局大致如何,但是在實踐中還是需要慢慢摸索
以下是一些php編程規范供大家參考。
一、文件標簽:
1.所有 php 文件都標有完整的 php 標簽。不推薦使用短標簽(短標簽容易與xml混淆,php從5.4開始默認不支持短標簽)。
2.對于 php-only 代碼文件,建議在末尾省略 '?>'。這是為了防止多余的空格或其他字符影響代碼。
二、文件和目錄命名
1.程序文件名和目錄名用有意義的英文命名,不要使用拼音和無意義的字母,只允許字母、數字、下劃線和下劃線,必須以'.php'結尾(模板文件除外),在多個單詞之間使用駝峰式大小寫。
示例: //該類統一采用:..php
//接口統一采用:..php
//其他按自己的方式:.{}.php
三、文件目錄結構
標準化的目錄結構便于團隊協作開發和后期維護。
--app //獨立應用
—— //單個類文件,共享類文件
--conf/inc //配置文件或目錄
--data //數據文件或目錄
--doc //程序相關文檔
-- //
—— //所有圖片文件存放路徑
——css //css文件
——js //js文件
——lib //共享類庫
—— //模板文件
——tmp //臨時文件目錄
-- //緩存文件
- //文檔
—— //編譯后的模板文件
——
- //上傳文件
—— //后臺管理文件目錄
四、 命名約定
1.變量命名:pHp 中的變量區分大小寫。有效的變量名稱以數字、字母或下劃線開頭,后跟任意數量的字母、數字和下劃線。
a) 程序整體采用駝峰式命名,以小寫字母開頭,名稱要有意義。( ())
b) pHp 全局變量鍵值兩邊都有'_',中間用駝峰命名。($[''])
c) 普通變量整體采用駝峰式,建議在變量前加前綴表示類型。不確定類型以大寫字符開頭。
d) 函數名稱應盡可能有意義并盡可能縮寫。
2.類和接口命名:
a) 以大寫字母開頭。
b) 由多個單詞組成的變量名,單詞之間沒有空格,每個單詞的首字母大寫。
c) 類名與類文件名一致。
d) 程序中的所有類名都是唯一的。
e) 抽象類應以 .
接口命名規則:
i) 采用與類相同的命名規則,但在其名稱前添加“i”字符網站模板,表示接口。
ii) 盡量使其與實現它的類名保持一致。
3.數據庫命名:在數據庫相關的命名中,不會出現大寫。
a) 所有表名都使用小寫字母。
b) 表名使用相同的前綴,且前綴不能為空。
c) 對于由多個單詞組成的表名,使用“_”間隔。
d) 表字段命名規則。
i) 使用全部小寫字母。
ii) 多個單詞不使用下劃線分隔。
iii) 用表名的第一個字母為常用字段添加前綴。
iv) 避免使用關鍵字和保留字。
五、注解規范
1.程序注釋:寫在代碼前面而不是后面,單行代碼按自定義寫在代碼末尾;大段注釋采用/**/的形式,通常在文件或函數的頂部,'//在代碼內部使用';評論不宜過多;代碼注釋應該描述原因而不是什么,并向代碼閱讀者提供最重要的信息。
2.文件注釋:文件注釋一般放在文件頂部,包括程序描述、作者、項目名稱、文件名、時間日期、版本信息,以及重要的使用說明(類調用、注意事項, ETC。) 。版本更改應修改版本號并添加注釋。
3.類和接口注解:一般來說,一個文件只包含一個類。
4.方法和函數注解:方法和函數注解是前面寫的,通常需要標明信息的主要可見性、參數類型和返回值類型。
/**
* 連接數據庫
* @$ 數據庫服務器地址
* @$ 數據庫用戶名
* @$ 數據庫密碼
*/
六、代碼風格
1.縮進和空格:使用4個空格作為縮進,不要使用Tab鍵;分配變量時,等號兩邊要留空格。($url = '$_GET['url']';)
2.語句換行:盡量保證一行程序語句是一個句子;盡量不要讓一行代碼過長,80個字符以內;如果一行代碼過長,請使用類似'.='的方法換行; 對數據庫的SQL語句進行操作時,盡量不要在函數中寫SQL語句,而是先用變量定義SQL語句,然后在執行操作的函數中調用定義的變量。
3.更好的習慣:在你的代碼中使用下面列出的方法讓你的代碼更優雅。
1):使用php中已經存在的常量,而不是自己定義。
示例://換行符
回聲 $msg."\r\n";
回聲$味精,;
它是php中預定義的常量,表示一行的結束。根據所使用的系統,代碼更具可移植性。
2):在 echo 中使用逗號作為連接符比使用 '.' 更美觀。作為連接器代碼。
3):單引號比雙引號效率高,但在用法上有區別。學習使用函數。
示例://回聲
echo '每個'.$.' 大約有 '.($avg).'';
//
$ = '每個 %s 有超過 $d 個學生';
($,$,$平均);
4) : 詳細評論
5):不要濫用語法糖。句法糖是一種語言中的一條潛規則,即一種不具有普遍代表性的語法。
舉兩個例子,如何寫出好的代碼
最經典的算法,獻給面試路上的你
如果您現在正在面試 pHp,請查看基本面試問題
文章題目:php代碼混淆為什么我們要培養自己的編碼規范?(圖)php源碼混淆類加密
網站路徑:http://m.newbst.com/news45/292945.html
成都網站建設公司_創新互聯,為您提供企業建站、域名注冊、定制開發、商城網站、網站收錄、外貿建站
聲明:本網站發布的內容(圖片、視頻和文字)以用戶投稿、用戶轉載內容為主,如果涉及侵權請盡快告知,我們將會在第一時間刪除。文章觀點不代表本網站立場,如需處理請聯系客服。電話:028-86922220;郵箱:631063699@qq.com。內容未經允許不得轉載,或轉載時需注明來源: 創新互聯
猜你還喜歡下面的內容