发表于: 2016-09-15 11:27:44
2 767
因为昨天发烧,下午回宿舍躺了一下午,所以很多事情没干
但是上午在看我们之前几个项目的代码的时候,发现注释和命名规范有很大的问题,结合我以往的工作经验这里我有几句话要说
1.不要把所有东西直接写在OnCreate里,而是在OnCreate里面新建个initData和initView方法,如本地保存的号码之类的消息放initData里,定义id之类的全放initView里面,
protected void onCreate(Bundle savedInstanceState) {
super.onCreate(savedInstanceState);
initData();
initView();
}
private void initData() {
/* 手机号取消本地保存 */
LoginModel mLoginModel = myApp.getSettingManager().getLoginModel();
LogUtils.i(TAG, "==mLoginModel.user_phone-->" + mLoginModel.user_phone);
user_phone = mLoginModel.user_phone;
mLoginModel.user_phone = "";
myApp.getSettingManager().saveLoginModel(mLoginModel);
code = getIntent().getStringExtra("code");
code = code == null ? "106" : code;
}
private void initView() {
setContentView(R.layout.activity_register);
/**手机号*/
et_register_phone = (EditText) findViewById(R.id.et_register_phone);
et_register_phone.addTextChangedListener(mTextWatcher);
/**密码*/
et_register_password = (EditText) findViewById(R.id.et_register_password);
et_register_password.addTextChangedListener(nTextWatcher);
/**注册*/
btn_register = (Button) findViewById(R.id.btn_register);
btn_register.setOnClickListener(mOnClickListener);
/**登陆*/
tv_register_login = (TextView) findViewById(R.id.tv_register_login);
tv_register_login.setOnClickListener(mOnClickListener);
/**关闭*/
tv_register_close = (TextView) findViewById(R.id.tv_register_close);
tv_register_close.setOnClickListener(mOnClickListener);
/**验证码*/
et_register_setcode = (EditText) findViewById(R.id.et_register_setcode);
// et_register_setcode.setOnClickListener(mOnClickListener);
/**获取验证码*/
btn_register_getcode = (Button) findViewById(R.id.btn_register_getcode);
btn_register_getcode.setOnClickListener(mOnClickListener);
/**手机叉叉*/
iv_login_delete1 = (ImageView) findViewById(R.id.iv_login_delete1);
iv_login_delete1.setOnClickListener(mOnClickListener);
/**密码叉叉*/
iv_login_delete2 = (ImageView) findViewById(R.id.iv_login_delete2);
iv_login_delete2.setOnClickListener(mOnClickListener);
}
这样维护的时候一目了然,会好很多
另外把点击时间和监听放一个注释模块,响应请求放一个注释模块,吧代码像土豆一样的切成一块块,需要哪个模块就直接shift+F的去找,这样不管是改bug还是增加功能都会便捷很多
2.代码的注释很关键,每定义一个控件的时候最好都写上这控件是干什么的,比如我这样
/**
* 手机号
*/
private EditText et_login_phone;
/**
* 密码
*/
private EditText et_login_password;
/**
* 注册
*/
private TextView tv_login_register;
/**
* 登陆
*/
private Button btn_login;
/**
* 关闭
*/
private TextView tv_login_close;
/**手机叉叉*/
private ImageView iv_login_delete1;
/**密码叉叉*/
private ImageView iv_login_delete2;
/**忘记密码*/
private LinearLayout ll_lost_password;
这样二次维护和新人上手的时候可以省略很多不必要的时间
在此建议用三点注释/**注释内容*/,因为eclipse但凡你三点注释了,吧鼠标放在下面任意一个被注释的空间上,是可以直接显示注释内容的,AS暂时好像还没有,但是目测这么好用的功能应该以后会加上,所以先习惯的好
3.控件的命名规范很重要,建议"控件缩写_服务的class_功能名称",比如登录界面的一个TextView手机号码,就写tv_login_phone,注册界面的button下一步就写btn_register_next.单词不会就去查,金山词霸,有道词典都很好用,不要在意多几个单词,用不了多少时间,但是当你隔很长时间重新维护这段代码的时候绝对很省略很多时间,大型企业和外企都是非常重视这规范的
4.唐浩你要是再敢写这种不带注释的代码,我今晚就把你给上了(#‵′)凸
“以下为反面教材↓”
评论