重修Android之利其器——代码规范

来源：互联网发布：交通灯软件框图编辑：程序博客网时间：2024/04/19 20:09

嗯，工作找不到，重新入山修炼，三十年后又是一条好汉！！！

记录一下自己的学习历程。既然要写代码，那么该准备的必须的准备好，楼主分享一下自己准备了些什么！

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;//定义常量内容1private 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();}@Overrideprotected void onCreate(Bundle savedInstanceState) {super.onCreate(savedInstanceState);setContentView(R.layout.activity_main);//调用字符串字符个数计算函数计算出CONETNT1的字符个数this.calulateCharsCount(this.CONETNT1);}<span style="color:#FF0000;">}</span>

大家可以使用javadoc直接生成文档来看一下自己的代码注释是否规范，还可以找出很多错误哦！！！！

0 0