我們寫代碼的時候，一個好的編碼規(guī)范，對我們來說能夠起到很多意向不到的效果：

1、提高我們的編碼效率。

2、提高代碼的可讀性。

3、顯示我們專業(yè)。別人看到了我們的代碼，發(fā)現(xiàn)整個代碼的書寫流程都整齊劃一，瞬間逼格就上去了！劃重點！??！

4、方便團隊協(xié)同工作。大家使用同一的規(guī)范，這樣就消除了五花八分的書寫方式，同一協(xié)調(diào)！

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

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

文件夾的命名：

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

文件的命名：

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

類名稱的命名：

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

方法名的命名：

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

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

關(guān)于變量，我們需要多說幾點：

1.無論在面向?qū)ο筮€是非面向?qū)ο蟮恼Z法中，變量統(tǒng)一使用小駝峰，如：$workYears。但是在面向?qū)ο笾杏钟兴煌?，public 、 protected 、 private ,protected或者private屬性的時候，前面加上了 _ 作為區(qū)別

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

3.全局變量，使用大駝峰，前綴加上 _ ,所有的單詞首字母大寫。因為知道一個變量的作用域是非常重要的，所以局部變量和全局變量應(yīng)該很明顯的進行分開！

示例：$_System_Config;$_Root_Path;

縮進符

關(guān)于編碼的縮進符號，我們統(tǒng)一使用制表符(tab)縮進！也許有的人會問為什么不適用空格縮進的呢？原因很簡單，大部分的編輯器都支持制表符等于多少個空格，而使用空格就沒得調(diào)了！

運算符號

所有的兩元運算符號，都應(yīng)該前后使用空格進行

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

很多人說好的代碼是不需要注釋的，其實，個人認為這種觀點是錯誤的。誰也不能保證不接手他人的代碼和他人不接手自己的代碼。多寫注釋，無論是對團隊的其他人，還是對自己都是非常友好的！

個人觀點，注釋至少有以下幾個作用：

1.解釋代碼功能 ，提高代碼的可讀性，提高團隊合作效率。畢竟讀你的注釋要比讀你的代碼要容易的多！

2.保留對代碼功能的理解。永遠不要過于相信自己的理解力！當(dāng)你思路通暢時，你可以很流暢的實現(xiàn)某個功能，但這種流暢可能是因為你當(dāng)時正處于這種開發(fā)思路中，為了能在再次閱讀這段代碼時，還能找回當(dāng)初編寫這段代碼的思路，建議添加注釋！

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

代碼注釋的種類

1、塊注釋，個人認為主要用在了三個地方。對php腳本的描述、對一個大的功能模塊的描述、在一行之內(nèi)不能寫完注釋的時候，也應(yīng)該放在塊注釋中

2、行注釋，個人認為他是配合塊注釋進行工作的！一般用于描述一個大的功能模塊的具體細節(jié)！

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

一、文件標記：

1.所有php文件，其代碼標記均采用完整php標簽，不建議使用短標簽（短標簽容易和xml混淆，php從5.4開始默認不支持短標記）。

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

二、文件和目錄命名

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

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

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

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

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

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

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

——class? ? ? ? ? //單個的類文件，共用的類文件

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

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

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

——htdocs? ? ? //document_root

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

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

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

——lib? ? ? ? ? ? ? //共用類庫

——template? ? //模板文件

——tmp? ? ? ? ? ? //臨時文件目錄

——cache? ? //緩存文件

——session? //SESSION文件

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

——other

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

——manage? ? //后臺管理文件目錄

四、命名規(guī)范

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

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

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

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

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

2.類及接口命名：

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

?? ? b）多個單詞組成的變量名，單詞之間不用間隔，各個單詞首字母大寫。

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

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

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

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

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

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

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

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

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

?? ? c）對于多個單詞組成的表名，使用‘_'間隔。

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

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

?? ? ? ? ? ? ii）多個單詞不用下劃線分割。

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

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

五、注釋規(guī)范

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

2.文件注釋：文件注釋一般放在文件的頂部，包括本程序的描述、作者、項目名稱、文件名稱、時間日期、版本信息、重要的使用說明（類的調(diào)用，注意事項等）。版本更改要修改版本號，并加上mofify注釋。

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

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

?? ?