1.利用androidstudio生成javadoc
非常简单,看下图,几个主要事项全部写在截图的标注上了,注意一下下哦:
选择我们要生成doc的项目
设置导出的配置(-encoding utf-8 -charset utf-8)
大功告成!
2.基本的代码代码规范
- 包名格式:域名反转+项目名,小写。比如site.zhangyun.theone. zhangyun.site为我的域名,theone为项目名。
- 类名:驼峰首字母大写,比如:MainActivity
- 类中final类型的变量全部大写,用下划线做分割。比如:
public final static String AUTONOMIC_SPEECH_ACTION = "com.efrobot.robot.action.AUTONOMIC_SPEECH";
- 类中public类型的变量写最前面,先写public申明,再写protected,再申明private
- 类中成员变量以小写m开头,比如:mContext.
- 类中静态变量以小写s开头,比如:sInstance.
- 每一行变量申明写完或者每个方法写完后空一行再写下一个
- 方法里面的变量名小写
目前记住的就这些了,等下次记住新的了再补上,如果对自己要求高的可以安装一个checkstyle插件导入有名的华为规范就可以自动帮您检查了,或者用谷歌默认的规范