[Java] 我的Coding Style 总结
1. 缩进
采用4个空格的缩进方式
2. tab
不采用"hard" tab。 需要更改编辑器的默认配置。将tab值改成4个空格。
3. 换行
3.1 一行不超过75个字符
3.2 如果太长,可以在:
- “,” 后换行
- 运算符前换行
4. 空格
4.1.在关键字和()之间加空格, 如: while ()
4.2. 运算符前后加空格
4.3. 在参数列表的“,”后加空格, 如: test(int id, string name)
4.4. 强制转换类型后加空格, 如: (object) x
5. 括号
不省略大括号和小括号
6. 空行
6.1. 导入的包之后加空行
6.2. 两个方法之间加空行
6.3. 局部变量和该方法中第一个逻辑语句之间加空行
6.4. if, while, for等 控制语句之前加空行
6.5. 行注释前加空行
7. 命名
7.1. 最重要的是要meaningful
7.2. 不使用生僻的单词
7.3. 太长的方法名, 可能是包含了多个功能,可以尝试拆分方法
7.4. 缩写时,建议把元音带上, 如message => MSG
7.5. 驼峰命名法。
7.6. 常量: 需要全大写, 单词与单词之间加"_".
7.7. 包: 单词中的每个字母都小写 例如: java.lang
7.8. 类的命令: 单词需是名词, 并且首字母大写
7.9. 接口: 单词需是名词, 并且首字母大写
7.10. 方法:单词需是动词, 并且首字母小写
7.11. 集合数组: 名字需是复数
7.12. 不重要的,临时变量: 采用标准名词, 如 Object o, Exception e, character c, d, e
8. 注释
8.1. 类和方法的注释一定要有。
8.2. 去除无用的comment, 通过变量名就可以了解含义
8.3. 如果有特殊的代码块,容易引起误解的,需要加注释。
8.4. 如果有多层循环, 可以在循环体的尾部加注释, 如//end while
8.5. 如果在switch中使用了fall through, 则需要加注释, 否则, 通常是要加break;
9. 其它
9.1. 类成员变量:需采用get, set 方法读取,设置
9.2. 重要的或重复的表达式或者方法应该提取出来。
9.2. 异常处理: 不忽略任何的异常信息。 如果要追踪更高级的异常, 不要忽略低级别的异常信息。
9.3. 释放资源:如果有需要释放资源, 需要放入finally块中。
其他参考:
http://www.oracle.com/technetwork/java/codeconvtoc-136057.html
http://www.infoq.com/news/2014/02/google-java-coding-standards/
[Java] 我的Coding Style 总结的更多相关文章
- Google's C++ coding style
v0.2 - Last updated November 8, 2013 源自 Google's C++ coding style rev. 3.274 目录 由 DocToc生成 头文件 ...
- 编程风格(Coding Style)要求
编程风格(Coding Style)要求2.1.1 文件(1) 每个模块(module)一般应存在于单独的源文件中,通常源文件名与所包含模块名相同.(2) 每个设计文件开头应包含如下注释内容:? 年份 ...
- Linux 内核Coding Style整理
转载:http://www.cnblogs.com/wang_yb/p/3532349.html 总结linux内核开发的coding style, 便于以后写代码时参考. 下面只是罗列一些规则, 具 ...
- (转帖) 有限狀態機FSM coding style整理 (SOC) (Verilog)
来源:http://www.codesoso.net/Record/101092_95120_21.html 来源:http://www.cnblogs.com/oomusou/archive/201 ...
- linux c coding style
Linux kernel coding style This is a short document describing the preferred coding style for the lin ...
- c coding style之学习篇
1. 使用do-while结构去避免潜在的内存泄漏问题. do { p1 = malloc(10); if (null == p1) { break; ...
- [中英对照]Linux kernel coding style | Linux内核编码风格
Linux kernel coding style | Linux内核编码风格 This is a short document describing the preferred coding sty ...
- 谈谈Linux内核驱动的coding style【转】
转自:http://www.cnblogs.com/wwang/archive/2011/02/24/1960283.html 最近在向Linux内核提交一些驱动程序,在提交的过程中,发现自己的代码离 ...
- 有限狀態機FSM coding style整理 (SOC) (Verilog)
AbstractFSM在數位電路中非常重要,藉由FSM,可以讓數位電路也能循序地執行起演算法.本文將詳細討論各種FSM coding style的優缺點,並歸納出推薦的coding style. In ...
随机推荐
- 【FreeMaker】FreeMaker学习-基础
转载请标明出处:http://www.cnblogs.com/ssslinppp 阅读目录 -04-08 08:08:08 Pacific Daylight Time Tue, Apr 8, '03 ...
- 浅析:setsockopt()改善socket网络程序的健壮性
1. 如果在已经处于 ESTABLISHED状态下的socket(一般由端口号和标志符区分)调用closesocket(一般不会立即关闭而经历TIME_WAIT的过程)后想继续重用该socket:BO ...
- MSSQL 随机查询且降序排列
--随机查询且降序排列 * FROM dbo.COMPANY_USER_INFO ORDER BY NEWID()) AS T ORDER BY T.cu_id DESC
- BeX5学习笔记
1.[窗口]——[首选项]中,有数据源等其它信息的设置,如下所示:
- nginx 负载均衡-- 常用nginx配置
中文官方网站http://wiki.nginx.org/Chshttp://www.howtocn.org/ --------------------------------------------- ...
- 1. redis简介
一. redis简介 Redis是一种面向"键/值"对数据类型的内存数据库,可以满足我们对海量数据的读写需求. redis的键只能是字符串,redis的值支持多种数据类型: (1) ...
- 补一篇关于Jackson和Gson的文章
一.关于Gson的问题 问题1. 如果对象属性里有[],表示它是一个列表,需要用List对象进行封装,不能用String来定义,不然转不了 问题2. Gson在解析的时候,如果json中有转义字符 \ ...
- codeforces 336D. Vasily the Bear and Beautiful Strings 组合数学 dp
题意: 给出n,m,g,求好串的个数 0 <= n,m <= 10^5,n + m >= 1,0 <= g <= 1 好串的定义: 1.只由0,1组成,并且恰好有n个0, ...
- Xcode 的正确打开方式——Debugging(转载)
Xcode 的正确打开方式——Debugging 程序员日常开发中有大量时间都会花费在 debug 上,从事 iOS 开发不可避免地需要使用 Xcode.这篇博客就主要介绍了 Xcode 中几种能 ...
- 2015 年最棒的 5 个 HTML5 框架
大多数的 web 开发者一直在用关键点来寻找动态的框架,这样能简化他们的设计和开发工作.HTML5 框架在所有的 web 浏览器和手机应用上都展现了优秀的性能.它不仅简化了 HTML5 开发中 CSS ...