Android/Java代码规范

1、引入包的要求(import)

a、引入类时必需写全类的完整路径,即不能使用*导入所需的类

b、不能导入没有使用的类


2、代码注释

ps:类、成员变量、常量、方法函数都必须使用javadoc格式注释

a、类注释

标注作者:必须是汉字,最多5个字符

b、方法函数注释(包含参数名与返回值得注释)

c、成员变量、常量注释


3、命名规范

a、包名规范:首字母小写,可包含数字,不能用下划线

b、常量规范:static需要写在final前面,字母必须大写,用下划线分割,可以包含数字,字符长度1-40

c、静态变量规范(static,non-final fields)首字母小写,驼峰标示,不能用下划线,字符长度1-25

d、成员变量规范:首字母小写,驼峰标示,可用下划线(model类适配前端),字符长度1-25

e、参数名规范:首字母小写,驼峰标示,可用下划线(model类适配前端),字符长度1-25

f、方法名规范:首字母小写,驼峰标示,不能用下划线,字符长度1-25


4、其他代码规范

a、方法的左大括号“{”代码同一行显示,右大括号“}”需新建一行

b、代码需要缩进

c、每行只能定义一个变量

d、数组定义采用java风格,即:int[] num;非:int num[];

e、TODO是javaIDE自动生成的。一般代码写完后要去掉。

f、一个文件类的代码行数不能超过2500行,一个方法不能超过300行,一行不能超过200个字符

g、如果是工具类,里面全是static方法,请写一个private的构造函数,避免外部new

h、long类型赋值时如果有加大写’L’,不要用小写’l’,因为与数字1相似(例如:100L)

i、switch必须要有default

j、switch中case后需要加入了跳出语句,例如:return、break、throw、continue

k、构造方法的参数不能超过10个,方法参数不能超过10个

m、if-else嵌套语句个数 最多4层

l、try-catch 嵌套语句个数 最多2层

n、一个方法的return不能超过5个

o、boolean值不能有冗余 比如if (b == true), b || true, !false

p、检查是否存在过度复杂的boolean返回值

q、只有私有构造器的类必须声明为final

r、interface方法不要用public、abstract修复

s、字符串比较必须使用equals(),而不是==

t、检查在重写了equals方法后是否重写了hashCode方法

u、成员变量用private修饰并提供get set方法给外部使用,不可直接用public修饰

总结:在save代码之前,请先格式化代码,eclipse快捷键 ctrl+shirt+F,android studio快捷键ctrl+opt+L


5、checkstyle配置

android studio:

1、插件安装

2、配置checkstyle.xml文件

3、检测代码


eclipse、myEclipse自行百度

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 203,547评论 6 477
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 85,399评论 2 381
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 150,428评论 0 337
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 54,599评论 1 274
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 63,612评论 5 365
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 48,577评论 1 281
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 37,941评论 3 395
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 36,603评论 0 258
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 40,852评论 1 297
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,605评论 2 321
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,693评论 1 329
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 33,375评论 4 318
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 38,955评论 3 307
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,936评论 0 19
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,172评论 1 259
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 43,970评论 2 349
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 42,414评论 2 342

推荐阅读更多精彩内容

  • 推荐文章:禅与 Objective-C 编程艺 前言 为􏰀高产品代码质量,指导广大软件开发人员编写出简洁、可维护、...
    WolfTin阅读 2,749评论 0 1
  • 老码农如何编写无法维护的代码 让自己稳拿铁饭碗 :D — Roedy Green(翻译版略有删节) 简介 永远不要...
    Clemente阅读 1,087评论 0 2
  • Android编码规范 源文件基础 文件名 源文件以其最顶层的类名来命名,大小写敏感,文件扩展名为.java。 文...
    呼呼哥阅读 930评论 0 0
  • 说明命名尽量做到见名知意,采用驼峰标识,禁止使用拼音或者表意不明确的标识(比如bianliang、i、j);命名无...
    hahaoop阅读 919评论 0 5
  • vi /etc/profile -> export FORCE_UNSAFE_CONFIGURE=1 -> sou...
    金哲虎阅读 2,535评论 0 1