php大牛班筆記課件下午書寫coding standard

1、書寫規(guī)范書寫規(guī)范作者：YOTQ 最后修改： )UJOTM 9ZGTJGXJ$參考資料：3GTGR6+8 )UJOTM 9ZGTJGXJY) )UJOTM 9ZGTJGXJNZZV ) 9Z_RK -OJK )VV )VV)UJOTM9ZGTJGXJ NZSR YT ZXTQ IVVMOJK SR)UJK )UTKTZOUTY LUX ZNK 0GGNZZ NZSR ZKINTKZUXQ PGG IUJKIUTZUI 制定規(guī)范時(shí)要注意： 、一般不要出現(xiàn) 個(gè)都行的情況。比如 ZGH 和 個(gè)空格都行，結(jié)果導(dǎo)致代碼。通用原則： 、語義化看到名字，就知道意思。 、通用前綴OY 表示是否、MKZ 表示讀、

2、YKZ 表示寫。OY 后面優(yōu)先跟形容詞，而不是名詞，比如是否多語言文字，應(yīng)使用 OYESRZOROTMGR，而不是 OYESRZORGTMGMK。 、單數(shù)與復(fù)數(shù)參考 PY 的函數(shù)命名規(guī)則：MKKSKTZ(_/J、MKKSKTZY(_:GM4GSK、MKKSKTZY(_4GSK。例如：取多個(gè)好友的名字，應(yīng)使用 MKZ,XOKTJY4GSK，而不是MKZ,XOKTJ4GSKY 或者 MKZ,XOKTJ4GSK取一個(gè)用戶，是 MKZ;YKX取多個(gè)用戶，是 MKZ;YKXY 、冗余后綴盡量不使用 JGZG、ROYZ、OTLU 后綴，除非特殊情況。比如，PY名就很注意，使用 MKKSKTZY(_:GM4

3、GSK 而不是 MKKSKTZY/TLU(_:GM4GSK。應(yīng)該使用 MKZ,XOKTJY 或者 MKZ,XOKTJY;YKX/J，而不是 MKZ,XOKTJY2OYZ；應(yīng)該使用 MKZ;YKX，而不使用 MKZ;YKX/TLU 或者 MKZ;YKX*GZG。不過有時(shí)候很難避免，比 個(gè)函數(shù)，分別是取用戶基本信息，和取用戶詳細(xì)信息。取用戶基本信息：昵稱、頭像 ;8/，函數(shù)名 MKZ;YKX(GYOI 還是 MKZ;YKX(GYOI/TLU？函數(shù)名以形容詞結(jié)尾感覺不合適。待。討論結(jié)果：MKZ;YKX(GYOI/TLU 合適。取用戶詳細(xì)信息：昵稱、頭像 ;8/、簽名、生日，函數(shù)名 MKZ;YKX沒問

4、題。 、含義模糊的類名、文件名、目錄名每當(dāng)使用 IUSSUT、ZOR、LTIZOUTY、IRGYY、UHPKIZ、HGYOI 作為文件名時(shí)要慎重，由于這些詞太通用，發(fā)展下去里面東西可 能越來越多，變成 箱。要給這些起一個(gè)準(zhǔn)確的名字，比如要做字符串處理的類，可以叫 9ZXOTM2OH ，放在 ROH 目錄里。 、ROH、VRMOT 與 GJJUT 的區(qū)別有些類、函數(shù)算做 ROH、VRMOT 還是 GJJUT。待 。 結(jié)果：目前增強(qiáng)函數(shù)算是 2OH，以后再考慮 VRMOT 和GJJUT。 、常用詞匯優(yōu)先使用 ;8/，而不是 ;82。因?yàn)楦鼑?yán)謹(jǐn)，新名開始使用 ;8/。比如 PY 的 KTIUJK;8

5、/，的 E9+8+8A 8+7;+9:E;8/ C。JKGJROTK 與 :2：JKGJROTK 表示最后時(shí)刻，:2 表示存活時(shí)間。比如現(xiàn)在時(shí)間是 ，:2 是 秒，則 JKGJROTK 是 # 。類名：大寫字母開頭，駝峰命名。一般使用名詞，比如配置)UTLOM6GXYKX，而不是 6GXYK)UTLOM。與 0GG、) 一致。類例如：IRGYKX3類的文件名：與類名相同。這與GZURUGJ 有關(guān)，為了 GZURUGJ，類名總結(jié)果：遵守駝峰，也能實(shí)現(xiàn)自動(dòng)類載入。要很長(zhǎng)。待與 0GG 一致。例如：IRGYKX3的文件名為 ;YKX3 非類文件名：全小寫，下劃線分隔，不得使用空格。比如 MKZEYN

6、V。目錄名：全小寫，下劃線分隔，不得使用空格。比如 S、。函數(shù)名：小寫字母開頭，駝峰命名，例如：LTIZOUT GJJ(RUM 。與 0GG、) 一致。函數(shù)表示功能，即動(dòng)作，所以動(dòng)詞優(yōu)先，例如使用 KJOZ(RUM，而不用 HRUM+JOZ。內(nèi)置函數(shù)由于歷史原因，有多種風(fēng)格，JUEYUSKZNOTM YUSKZNOTMEJU JUYUSKZNOTM 比較新的函數(shù)用了 JU9USKZNOTM，才與目前主流語言保持一致。比如：VGYKXEYZX、PYUTEKTIUJK、YHYZX、LKZINRR。歷史原因可能無法改變，但能保證新的代碼是嚴(yán)謹(jǐn)?shù)?，不要讓自己成為歷史原因。類中的函數(shù)：兩個(gè)函數(shù)中間空一行

7、。如果有時(shí)間的話，各個(gè)函數(shù)按英文字母排序，免得太。例如：IRGYY (RUM3aVHROI LTIZOUT GJJ(RUM a cVHROI LTIZOUT VJGZK(RUM acc文件注釋：注釋緊跟%下一行。注明作者。&KX暫不需要寫，因?yàn)閅T 提供了版本管理。格式按照J(rèn)UI 的要求：NVUX ZZUXOGREZGMY GZNUX VQM NZSR % HRUM 的各種業(yè)務(wù)：添加、更新&GZNUX YOTQ IRGYY (RUM3ac%$6/ 注釋：一定要寫輸入?yún)?shù)，和輸出格式。寫清楚正確時(shí)輸出什么，錯(cuò)誤時(shí)輸出什么。否則別人無法使用。函數(shù)注釋：一定要寫輸出格式。寫清楚正確時(shí)輸出什么，錯(cuò)誤時(shí)

8、輸出什么。如果輸入?yún)?shù)比較復(fù)雜，包含數(shù)組，看參數(shù)無法一目了然，則要寫輸入?yún)?shù)的注釋。文檔注釋與函數(shù)之間不能有空行。如果函數(shù)例如： 更新 HRUM&VGXGS步驟比較復(fù)雜，需要寫“行內(nèi)注釋”。 OJ HRUMEOJ* &VGXGS GXXG_ JGZG GXXG_ IUTZKTZ #$ 內(nèi)容 ZGMY #$ VJGZKEZOSK #$ 更新時(shí)間 * &XKZXT HUUR VHROI LTIZOUT VJGZK(RUM OJ JGZG aYZKV 第一步：GYJL YZKV 第二步：WKXc;8/：根據(jù) XLI 國際標(biāo)準(zhǔn)的規(guī)定，名不區(qū)分大小寫。中出現(xiàn)下劃線“E”，域比如 NZ 是錯(cuò)誤。與相同。所

9、以優(yōu)先在 ;8/ 中使用全小寫，-+: 的TGSK 小寫，但是 -+: 的值除外。比如NZZNZZ;8/ 中非參數(shù)的專有名詞的縮寫是否使用小寫，有爭(zhēng)議無定論。比如 NZZV NZZV KT Y 語言文字代碼是專有名詞，/95 規(guī)定必須是減號(hào)，且建議地區(qū)使用大寫。LKJUXG 的用法很奇怪，使用了自己制造的，而不是。而且不建議在 ;8/ 中使用下劃線。OQO 用了小寫，用了大寫，微軟用了小寫。優(yōu)先在 ;8/ 中使用減號(hào)“ ”，而不是下劃線，-+: 的 TGSK 除外。比如 %YKXEOJ# 如果希望用戶手動(dòng)輸入 ;8/，則不要區(qū)分大小寫，且優(yōu)先使用小寫，因?yàn)橛脩糨斎敫奖?。?shí)際情況是：用戶一般是

10、手動(dòng)輸入，而不手動(dòng)輸入 ;8/，因?yàn)?8/ 很長(zhǎng)。在這種情況下，;8/ 小寫是否有意義，如果使用 %YKX/J# ，變量名就可以使用駝峰 YKX/J # E-+:A YKX/J C，就能夠和 0GG、) 保持一致，這樣數(shù)據(jù)庫也要駝峰命名。待。結(jié)果：使用%YKXEOJ# 。變量：全小寫，下劃線分隔，例如： YKXEOJ 或 YKX/J!與 0GG、) 不一致。結(jié)果：使用 YKXEOJ。類的成員變量、函數(shù)的形參、類實(shí)例化成一個(gè)對(duì)象，都遵守變量的命名規(guī)則。原因：;8/、數(shù)據(jù)庫有小寫慣例，從 E-+:、 E入庫，所以用小寫。: 中獲得參數(shù)內(nèi)置變量 E-+:、 E: 使用下劃線開頭，全大寫。自定義的變量

11、無論多么重要，都不要使用下劃線開頭，以免將來與內(nèi)置變量。比如：不要使用 E6;:、 E*+2+:+。常量：全大寫，下劃線分隔。例如：IUTYZ 3+3).+E:2 # !短使用%于部署。：%$，不使用短% %$。因?yàn)榕c SR，且不利類大括號(hào)換行：可以采用大括號(hào)單獨(dú)占一行，也可以大括號(hào)與別的放在一行，有爭(zhēng)議無定論，待。a結(jié)果：使用“”。IRGYKX3c支持換行者：函數(shù)大括號(hào)換行：有爭(zhēng)議無定論，待LTIZOUT MKZ;YKX a。結(jié)果：使用“”。c支持換行者：OL 大括號(hào)換行：有爭(zhēng)議無定論，待例如：。結(jié)果：使用“”。OL KSVZ_ TGSK ac或者OL KSVZ_ TGSK a 確定c支持換

12、行者：NZZV HXGIK )VV )VV)UJOTM9ZGTJGXJ NZSR 支持者：YOZIN 大括號(hào)換行：結(jié)果：使用“YOZIN a IGYK HXKGQ!”。JKLGRZ c支持換行者：NZZV YOZIN )VV )VV)UJOTM9ZGTJGXJ NZSR 數(shù)組小括號(hào)換行：有爭(zhēng)議無定論。 YKX # GXXG_ OJ #$ 結(jié)果：使用“”。 TGSK #$ YKX #$ 支持者：數(shù)組換行： 維及以上數(shù)組的數(shù)組如 YKX # GXXG_ OJ #$ 換行。 TGSK #$ YKX #$ ! 維數(shù)組如不換行。結(jié)果： 維數(shù)組不換行。 YKXYEOJ # GXXG_ ! 確定數(shù)組最后的逗

13、號(hào)：數(shù)組每一行最后要有逗號(hào)，這樣方便以后添加。不過前端 0954 最后不能有逗號(hào)，否則有的瀏覽器不支持，待因?yàn)楹蠖瞬挥每紤] /+ 前端。比如 YKX # GXXG_ OJ #$ 結(jié)果：都行， TGSK #$ YKX 都行，優(yōu)點(diǎn)：大數(shù)組，經(jīng)常添加一行，方便。如果沒有逗號(hào)，確實(shí)太難以添加了。 ! YKX # GXXG_ OJ #$ TGSK #$ YKX 都行，優(yōu)點(diǎn)：嚴(yán)謹(jǐn)，逗號(hào)表示分隔，最后一個(gè)不需要分隔。 !單引號(hào)與雙引號(hào)：優(yōu)先使用單引號(hào)，當(dāng)需要轉(zhuǎn)義時(shí)使 引號(hào)，變量不放在雙引號(hào)中。這與 0954 不同，0954 全是雙引號(hào)，待 。 結(jié)果：優(yōu)先使用單引號(hào)。比如：KINU TGSK OY TGSK

14、BT ! YKX # GXXG_ OJ #$ !條件判斷的大括號(hào)：必須有大括號(hào)，即使只有一行。正確：OL KSVZ_ TGSK a JU9USKZNOTM !c錯(cuò)誤：OL KSVZ_ TGSK JU9USKZNOTM !回車換行：使用換行 2,（BT， G，;TO 風(fēng)格）。不使用 )8 2,（=OTJUY風(fēng)格）。參考： + , ( + ) KIROVYKUXQYVGIK4K ZKZ LORK ROTK JKROSOZKX5ZNKX：;TO編碼：使用 ;:, TU (53。不得使用 =OTJUY 記事本進(jìn)行保存，因?yàn)橛浭卤臼?;:, (53 )8 2,。KIROVYKUXQYVGIK:KZ LO

15、RK KTIUJOTM5ZNKX：;:, 縮進(jìn)：使用 個(gè)空格進(jìn)行縮進(jìn)，也可以采用 ZGH 進(jìn)行縮進(jìn)。個(gè)空格。支持 個(gè)空格者： 確定結(jié)果： NZZ NZSR ZKINTKZUXQ PGG IUJKIUTKTZOUTY支持 個(gè)空格者： YT ZXTQ IVVMOJK SR 9VGEY E:GHY支持 、 或 個(gè)空格者：NZZV OTJKTZ )VV )VV)UJOTM9ZGTJGXJ NZSR 要保證縮進(jìn)正確，如果使用 個(gè)空格，一定不要出現(xiàn) 個(gè)空格或者 個(gè)空格。KIROVYK-KTKXGR+JOZUX:KZ +JOZUXYYNUNOZKYVGIK INGXGIZKXYOS d OSXI YKZ K

16、VGTJZGHYKZ YULZZGHYZUV# YKZ YNOLZOJZN# YKZ GZUOTJKTZ.:6 協(xié)議緩存：文章使用 2GYZ 3UJOLOKJ 表示最后修改時(shí)間，不緩存。NKGJKX 2GYZ 3UJOLOKJ 9GZ 5IZ3: !需要用戶登錄的頁面，緩存。NKGJKX )GINK )UTZXUR SG GMK# !NKGJKX )GINK )UTZXUR VXOGZK !.:6 協(xié)議編碼與 SOSK：.:6 輸出一定要編碼與 SOSK。INGXYKZ 與分號(hào)之間要有一個(gè)空格。小寫 ZL 還是大寫 ;:, ，尚未找到文檔，待調(diào)研。比如NKGJKX )UTZKTZ :_VK GVVROIGZOUT PYUT! INGXYKZ#;:, ! NKGJKX )UTZKTZ :_VK GVVROIGZOUT SR! INGXYKZ#;:, ! NKGJKX )UTZKTZ :_VK GVVROIGZOUT NZSR SR!INGXYKZ#;:, !NKGJKX )UTZKTZ :_VK ZKZ VRGOT! INGXYKZ#;:, ! NKGJ