我們寫代碼的時(shí)候厘托，一個(gè)好的編碼規(guī)范，對(duì)我們來(lái)說(shuō)能夠起到很多意向不到的效果：

1稿湿、提高我們的編碼效率铅匹。

2、提高代碼的可讀性饺藤。

3包斑、顯示我們專業(yè)。別人看到了我們的代碼涕俗，發(fā)現(xiàn)整個(gè)代碼的書寫流程都整齊劃一罗丰，瞬間逼格就上去了！劃重點(diǎn)Ｔ俟谩Ｃ鹊帧！

4元镀、方便團(tuán)隊(duì)協(xié)同工作绍填。大家使用同一的規(guī)范，這樣就消除了五花八分的書寫方式栖疑，同一協(xié)調(diào)讨永！

編碼規(guī)范包含兩大塊，代碼的書寫規(guī)范和注釋的書寫規(guī)范遇革。

1.代碼的書寫規(guī)范

文件夾的命名：

文件夾同一使用小寫字母卿闹。如存放控制器的文件夾揭糕，直接命名為controller即可

文件的命名：

如果是類文件的話，那么文件的命名應(yīng)該同類名稱保持一致比原，統(tǒng)一使用大駝峰插佛。如Session.class.php , 對(duì)應(yīng)類名稱為Session，如果是普通的工具腳本量窘，那么統(tǒng)一使用小駝峰，如common.php

類名稱的命名：

類名稱同一使用大駝峰氢拥，Cookie類

方法名的命名：

統(tǒng)一使用小駝峰蚌铜，一般使用 動(dòng)詞 + 名次 的形式來(lái)描述該方法的功能，如sendMessage,發(fā)送短信嫩海。在面向?qū)ο笾卸辏裱瑯拥囊?guī)則，但是個(gè)別地方有所區(qū)別：

變量的命名規(guī)范：

關(guān)于變量叁怪，我們需要多說(shuō)幾點(diǎn)：

1.無(wú)論在面向?qū)ο筮€是非面向?qū)ο蟮恼Z(yǔ)法中审葬，變量統(tǒng)一使用小駝峰，如：$workYears奕谭。但是在面向?qū)ο笾杏钟兴煌辆酰琾ublic 、 protected 血柳、 private ,protected或者private屬性的時(shí)候官册，前面加上了 _ 作為區(qū)別

2.如果是常量的話，統(tǒng)一使用大寫难捌，中間使用下劃線進(jìn)行分割膝宁。

3.全局變量，使用大駝峰根吁，前綴加上 _ ,所有的單詞首字母大寫员淫。因?yàn)橹酪粋€(gè)變量的作用域是非常重要的，所以局部變量和全局變量應(yīng)該很明顯的進(jìn)行分開击敌！

示例：$_System_Config;$_Root_Path;

縮進(jìn)符

關(guān)于編碼的縮進(jìn)符號(hào)介返，我們統(tǒng)一使用制表符(tab)縮進(jìn)！也許有的人會(huì)問(wèn)為什么不適用空格縮進(jìn)的呢愚争？原因很簡(jiǎn)單映皆，大部分的編輯器都支持制表符等于多少個(gè)空格，而使用空格就沒(méi)得調(diào)了轰枝！

運(yùn)算符號(hào)

所有的兩元運(yùn)算符號(hào)捅彻，都應(yīng)該前后使用空格進(jìn)行

2.注釋的書寫規(guī)范

很多人說(shuō)好的代碼是不需要注釋的，其實(shí)鞍陨，個(gè)人認(rèn)為這種觀點(diǎn)是錯(cuò)誤的步淹。誰(shuí)也不能保證不接手他人的代碼和他人不接手自己的代碼从隆。多寫注釋，無(wú)論是對(duì)團(tuán)隊(duì)的其他人缭裆，還是對(duì)自己都是非常友好的键闺！

個(gè)人觀點(diǎn)，注釋至少有以下幾個(gè)作用：

1.解釋代碼功能 澈驼，提高代碼的可讀性辛燥，提高團(tuán)隊(duì)合作效率。畢竟讀你的注釋要比讀你的代碼要容易的多缝其！

2.保留對(duì)代碼功能的理解挎塌。永遠(yuǎn)不要過(guò)于相信自己的理解力！當(dāng)你思路通暢時(shí)内边，你可以很流暢的實(shí)現(xiàn)某個(gè)功能榴都，但這種流暢可能是因?yàn)槟惝?dāng)時(shí)正處于這種開發(fā)思路中，為了能在再次閱讀這段代碼時(shí)漠其，還能找回當(dāng)初編寫這段代碼的思路嘴高，建議添加注釋！

3.代碼注釋即文檔和屎！程序源代碼是程序文檔的重要組成部分拴驮，當(dāng)我們想著把各種軟件相關(guān)文檔寫注釋的重要性規(guī)范的時(shí)候，不要忘了把軟件里最重要的文檔眶俩，源代碼注釋寫規(guī)范莹汤！

代碼注釋的種類

1、塊注釋颠印，個(gè)人認(rèn)為主要用在了三個(gè)地方纲岭。對(duì)php腳本的描述、對(duì)一個(gè)大的功能模塊的描述线罕、在一行之內(nèi)不能寫完注釋的時(shí)候止潮，也應(yīng)該放在塊注釋中

2、行注釋钞楼，個(gè)人認(rèn)為他是配合塊注釋進(jìn)行工作的喇闸！一般用于描述一個(gè)大的功能模塊的具體細(xì)節(jié)！

下面附上一些php的編程規(guī)范询件，給大家參考下

一燃乍、文件標(biāo)記：

1.所有php文件，其代碼標(biāo)記均采用完整php標(biāo)簽宛琅，不建議使用短標(biāo)簽（短標(biāo)簽容易和xml混淆刻蟹，php從5.4開始默認(rèn)不支持短標(biāo)記）。

2.對(duì)于只有php的代碼文件嘿辟，建議省略結(jié)尾處的‘?>'舆瘪。這是為了防止多余的空格或其他字符影 響到代碼片效。

二、文件和目錄命名

1.程序文件名和目錄名均采用有意義的英文命名英古，不使用拼音和無(wú)意義的字母淀衣，只允許出現(xiàn)字母、數(shù)字召调、下劃線和中劃線字? 符膨桥，同時(shí)必須以‘.php'結(jié)尾（模板文件除外），多個(gè)詞間使用駝峰命名法唠叛。

?? ? 例：//類統(tǒng)一采用：DemoTest.class.php

?? ? ? ? ? //接口統(tǒng)一采用：DemoTest.interface.php

?? ? ? ? ? //其他按照各自的方式：demoTest.{style}.php

三国撵、文件目錄結(jié)構(gòu)

規(guī)范的目錄結(jié)構(gòu)有助于團(tuán)隊(duì)協(xié)作開發(fā)和后期維護(hù)。

——app? ? ? ? ? ? //獨(dú)立的應(yīng)用

——class? ? ? ? ? //單個(gè)的類文件玻墅，共用的類文件

——conf/inc? ? //配置文件或目錄

——data? ? ? ? ? //數(shù)據(jù)文件或目錄

——doc? ? ? ? ? //程序相關(guān)文檔

——htdocs? ? ? //document_root

——images? ? ? //所有圖片文件存放路徑

——css? ? ? ? ? ? //css文件

——js? ? ? ? ? ? ? //js文件

——lib? ? ? ? ? ? ? //共用類庫(kù)

——template? ? //模板文件

——tmp? ? ? ? ? ? //臨時(shí)文件目錄

——cache? ? //緩存文件

——session? //SESSION文件

——template_c? ? //編譯后的模板文件

——other

——upload? ? ? //上傳文件

——manage? ? //后臺(tái)管理文件目錄

四、命名規(guī)范

1.變量命名：php中變量區(qū)分大小寫壮虫，一個(gè)有效的變量名由數(shù)字澳厢、字母或下劃線開頭，后面跟任意數(shù)量的字母囚似、數(shù)字剩拢、下劃線。

?? ? a）程序整體以駝峰命名法饶唤，以小寫字母開始徐伐，同時(shí)命名要有意義。（function displayName()）

?? ? b）PHP全局變量鍵值兩邊都有‘'募狂，中間用駝峰命名法命名办素。（$GLOBAL['beginTime']）

?? ? c）普通變量整體采用駝峰命名法，建議在變量前加表示類型的前綴祸穷。不確定類型的以大寫字符開頭性穿。

?? ? d）函數(shù)名要盡量有意義，盡量縮寫雷滚。

2.類及接口命名：

?? ? a）以大寫字母開頭需曾。

?? ? b）多個(gè)單詞組成的變量名，單詞之間不用間隔祈远，各個(gè)單詞首字母大寫呆万。

?? ? c）類名與類文件名保持一致。

?? ? d）程序中所有的類名唯一车份。

?? ? e）抽象類應(yīng)以Abstract開頭谋减。

?? ? 接口命名規(guī)則：

?? ? ? ? i）采用和類相同的命名規(guī)則，但在其命名前加‘i'字符躬充，表示接口逃顶。

?? ? ? ? ii）盡量保持和實(shí)現(xiàn)它的類名一致讨便。

3.數(shù)據(jù)庫(kù)命名：在數(shù)據(jù)庫(kù)相關(guān)命名中，一律不出現(xiàn)大寫以政。

?? ? a）表名均使用小寫字母霸褒。

?? ? b）表名使用同一的前綴且前綴不能為空。

?? ? c）對(duì)于多個(gè)單詞組成的表名盈蛮，使用‘_'間隔废菱。

?? ? d）表字段命名規(guī)則。

?? ? ? ? ? ? i）全部使用小寫字母抖誉。

?? ? ? ? ? ? ii）多個(gè)單詞不用下劃線分割殊轴。

?? ? ? ? ? ? iii）給常用字段加上表名首字母做前綴。

?? ? ? ? ? ? iv）避免使用關(guān)鍵字和保留字袒炉。

五旁理、注釋規(guī)范

1.程序注釋：寫在代碼前面而不是后面，單行代碼按照習(xí)慣寫在代碼尾部我磁；大段注釋采用/**/的方式孽文，通常為文件或函數(shù)的頂部，代碼內(nèi)部使用'//'夺艰；注釋不宜太多芋哭；代碼注釋應(yīng)該描述為什么而不是做什么，給代碼閱讀者提供最主要的信息郁副。

2.文件注釋：文件注釋一般放在文件的頂部减牺，包括本程序的描述、作者存谎、項(xiàng)目名稱拔疚、文件名稱、時(shí)間日期愕贡、版本信息草雕、重要的使用說(shuō)明（類的調(diào)用，注意事項(xiàng)等）固以。版本更改要修改版本號(hào)墩虹，并加上mofify注釋。

3.類和接口注釋：按照一般的習(xí)慣憨琳，一個(gè)文件只包含一個(gè)類诫钓。

4.方法和函數(shù)注釋：方法和函數(shù)的注釋寫在前面，通常需要表明信息的主要可見性篙螟、參數(shù)類型和返回值類型菌湃。

?? ?