重修Android之利其器——代碼規範

   嗯,工作找不到 ,重新入山修煉,三十年後又是一條好漢!!!


    記錄一下自己的學習歷程。既然要寫代碼,那麼該準備的必須的準備好,樓主分享一下自己準備了些什麼!


   1.編譯工具——ADT

    縱觀現在能進行安卓開發的工具:ADT,Android Studio,VS2015,IntelliJ IDEA,個人還是挺鍾愛ADT的,大家可以挑選自己最喜歡的工具。

   2.SDK版本——19

    由於Android L還沒有完全推出,所以成熟一點的4.4x當然是我輩首選,於是我選擇了API19。AVD使用的Intel的image,然後配置的加速,當然大家也可以選擇Genymotion,但是個人還是認爲使用了Intel加速的AVD是蠻快的。SDK更新是通過修改hosts文件進行更新的,當然大家也可以選擇其他方法。

   3.其他輔助軟件

  •  Source Insight  3.5     //源碼查看軟件,查看android源代碼的工具,有了源代碼都不用看文檔了,直接就在源碼中看就行了
  •  Beyond Compare4     //文件差異對比軟件,可以對兩個文件或目錄進行對比找出差異,蠻不錯的一個工具!
  • github客戶端                 //版本控制軟件,其實沒有必要下載這個的,直接用git這個軟件業可以,但是還是想學習學習。
  • 有道詞典                        //咳咳……這個毫無疑問是英語較差的同學下載的,如同樓主這樣的。
  • 有道雲筆記                    //恩恩這個可以記錄下很多需要紀錄下的東西。
     正題
 
文件命名:JAVA的首字母大寫

在Android 官方源碼中,進入之後有個各種介紹

pakage都是小寫

android的幫助文檔用的JAVADOC生成的

常量全部大寫,然後以下滑線分割

私有成員變量加上m

類變量加上小s
static String sMyName;


目錄需要規範

組織名.項目名.模塊名
Pascal       String MyAge;       Delphe常用
Camel(駝峯)String myAge;       JAVA常用
匈牙利       String strMyName;   VB常用
下劃線命名法 String s_MyName     C++常用

誰都採用,誰都不完全採用

方法(動賓短語)


嚴格換行(儘量工整)
嚴格縮進
嚴格註釋(文件,類,方法,方法參數,變量,屬性)


一段代碼體現一下,主要是命名規範以及註釋規範,不一定用的好,但是樓主儘量向這方面努力,還望各位能多多指點:


/**
 * 對代碼規範的一個示例Activity類
 * @author tenma
 * @date 2015-2-4
 * @company none
 * <h1>version:1.0</h1>
 */
package sourceruledemo.tenma.sourceruledemo;

import android.os.Bundle;
import android.app.Activity;


/**
 * 對代碼規範的一個示例Activity類
 * 
 * @author tenma
 * @since level 8(andriod 2.0)
 * @version 1.0
 * 
 */
public class MainActivity extends Activity {
	
	//定義成員變量:內容
	private String mContent;
	//定義常量內容1
	private final String CONETNT1="傳入的是內容1";
	
	/**
	*得到內容
	*@return 得到的內容
	*/
	public String getmContent() {
		return mContent;
	}
	
	/**
	*設置內容
	*@param mContent 具體的內容
	*/
	public void setmContent(String mContent) {
		this.mContent = mContent;
	}

	/**
	 * 根據傳入的字符串計算字符個數
	 * @param mContent 字符串內容
	 * @return 返回字符串長度
	 * @author tenma
	 * @date 2015-2-4
	 * @version 1.0
	 *
	 */
	public int calulateCharsCount(String mContent){
		return mContent.length();
	}
	
	@Override
	protected void onCreate(Bundle savedInstanceState) {
		super.onCreate(savedInstanceState);
		setContentView(R.layout.activity_main);
		//調用字符串字符個數計算函數計算出CONETNT1的字符個數
		this.calulateCharsCount(this.CONETNT1);
	}


<span style="color:#FF0000;">}
</span>

        大家可以使用javadoc直接生成文檔來看一下自己的代碼註釋是否規範,還可以找出很多錯誤哦!!!!


發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章