Android編碼規範

標籤：

四種常見的命名法

比較Java和c#的命名規範的不同點

常量用大寫

java方法首字母不大寫，應該小寫

函數行數限制

不要用拼音

參照物，Android源碼

看源碼工具，SourceInsight 和 Beyond Compare

import中同類的放在一起

Android 文檔通過java.doc 實現

私人程式變數命名最前面加m

目錄規範

系統目錄規範，項目一級文檔

• Deployment
• Requirement （需求相關的文檔）
• Designn
• Planning
• Help
• Log
• Source
• Publish
• Test

原始碼命名規範

• 目錄即包（package）
• 目錄下所有類都屬於此命名空間：一主類一檔案
• 目錄層次遞迴
• 一般系統命名空間目錄盡量不要超過3層

代碼命名規範命名方法

• 匈牙利命名法：strMyName，mMyName，int intMyName 用一個首碼來標誌一些東西，常用於VB6

• Pascal命名法：每個單詞的首字母大寫 MyName

• Camel命名法：駝峰命名法 首字母小寫，其他的首字母大寫 java變數命名 myName

• 底線命名法：s_MyName，m_Name

私人成員變數 Pascal命名＋首碼m
靜態成員變數 Pascal命名＋首碼s，在方法中則不加s
局部變數 Camel命名法，或者用底線開頭加Pascal方法
方法參數 Camel命名法，首碼用p
迴圈中的變數 可以用無意義的字母

注釋：檔案，類，方法，方法參數，變數，屬性都要注釋
檔案和類的注釋一定要包含如下元素：Name，Descrition，Version，Date，Author，Change，Copyright
遵循JavaDoc標準

編碼邏輯規範

避免將多個類放在一個檔案裡面，除非是一次性使用的內部類
一個方法的代碼長度最好不要超過35行
原則上，盡量不要手動修改機器產生的代碼
Final String 取代直接String 同理int
不推薦在迴圈語句中，進行直接的return操作
不要用goto
處處要考慮異常
僅對需要對外公布採用public，其餘的用private or internal
盡量不要提供public and protected 程式員變數，使用屬性代替他們
不要在系統自動產生的函數直接寫業務代碼，最好自訂函數，然後調用
總是使用介面，推薦使用顯示介面實現
在switch語句中總是要有default字句來顯示資訊

Android編碼規範