PHP框架實戰(零):代碼規範

| Comments

類C語言語法風格最大的問題就是用花括號區分代碼塊,這導致源碼排版容易混亂,對於我這種有代碼潔癖的人來說非常痛苦,所以我最喜歡的語法風格是Python的,用縮進區分代碼塊,排版不規範直接判處語法錯誤。

命名規範

所有命名使用駝峰風格。

源碼開頭定義命名空間,Flamework框架入口類的命名空間為“org\x3f\flamework”,其餘類的命名空間應在此基礎上追加與所在目錄路徑匹配的內容。例如,框架源碼目錄下一級子目錄“base”中的類文件的命名空間均為“org\x3f\flamework\base”。

類名必須是名詞,不允許添加任何無意義的前綴或後綴,只允許使用大小寫英文字母且首字母大寫。

方法名必須是“動詞+名詞”的形式(如果動詞意義明確且不需要賓語,可省略後者),只允許使用大小寫英文字母及阿拉伯數字和下劃線,首字母小寫。

屬性名分两种情况,对于存储普通数据的属性,名称必須是名詞;对于布尔型属性,名称必须是“動詞+名詞”的形式。只允許使用大小寫英文字母及阿拉伯數字和下劃線,首字母小寫。

源碼文件名必須與類名相同,後綴統一使用“.php”。

註釋規範

統一使用phpDocumenter的註釋規範。

類註釋必須註明@author、@since。

屬性和方法的作者如果和類的創建者不同,必須註明@author,此外必須註明@since。

文件格式

所有文本文件統一使用UNIX格式和UTF-8編碼。

嚴禁使用製表符縮進代碼,必須使用4個空格替代製表符。

類、屬性、方法、方法內部代碼塊都必須嚴格按照層級縮進。

Comments