[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/

时间: 2024-10-14 01:00:34

[Java] 我的Coding Style 总结的相关文章

Java coding style - Part one

Java coding style: 1. Factory method should be stateless. State normally refers to the member variables of class. Stateless, more precisely, it means immutable. Factory is just to create objects, and one call should not affect anothers, if it is muta

Google's C++ coding style

v0.2 - Last updated November 8, 2013 源自 Google's C++ coding style rev. 3.274 目录 由 DocToc生成     头文件        #define用法        前向声明        内联函数        -inl.h文件        函数参数顺序        include的命名和顺序    作用域        命名空间            未命名空间            命名空间       

编程风格(Coding Style)要求

编程风格(Coding Style)要求2.1.1 文件(1) 每个模块(module)一般应存在于单独的源文件中,通常源文件名与所包含模块名相同.(2) 每个设计文件开头应包含如下注释内容:? 年份及公司名称.? 作者.? 文件名.? 所属项目.? 顶层模块.? 模块名称及其描述.? 修改纪录.2.1.2 大小写(1) 如无特别需要,模块名和信号名一律采用小写字母.(2) 为醒目起见,常数(`define定义)/参数(parameter定义)采用大写字母.2.1.3 标识符(1) 标识符采用传

linux c coding style

Linux kernel coding style This is a short document describing the preferred coding style for the linux kernel. Coding style is very personal, and I won't _force_ my views on anybody, but this is what goes for anything that I have to be able to mainta

[CPP] Coding Style

C++ Coding Style C++很多强大的语言特性导致它的复杂,其复杂性会使得代码更容易出现bug.难于阅读和维护. 本Coding Style用来约束C++编程,使得代码在有效使用C++语言特性的同时易于管理[代码的一致性高于一切]. 参考:<Google C++ Style Guide> 分类 标题 规则 备注(示例) 头文件 每个.cc文件都应对应一个.h文件 #define保护 1.  #define PROJECT_PATH_FILE_H_ 防止.h文件被多重包含: 1. P

Google C++ Coding Style:引用参数

Google C++ Coding Style定义 输入参数以值或者const引用形式传入,输出参数使用指针. 所有以引用形式输入参数必须加上const,即const T&的形式. 即如下形式: void Foo(const string &in, string *out); 在如下情况下, 可以使用const T*的形式: * 需要进行指针的判空 (即空指针是合理的). * 需要使用到输入参数的指针或引用形式. 为什么要使用const T&形式? 以值传入是最为安全的形式,因为它

Verilog case coding style

1.一般情况下,综合器将case语句综合成多路选择器,但也可能综合成优先级译码器. 2.case语句中,如果条件列举不完全,将综合出不必要的锁存器. 综合器指令://synopsys parallel_case & //synopsys full_case 使用//synopsys parallel_case可以引导综合器生成多路选择器. 1 always @(cs_state) 2 begin 3 case(cs_state) // synopsys parallel_case 4 2'b00

【Android XML】Android XML 转 Java Code 系列之 style(3)

最近一个月把代码重构了一遍, 感觉舒服多了, 但总体开发进度没有变化.. 今天聊聊把style属性转换成Java代码的办法 先说结论: 引用系统style是无法完美的实现的, 我们如果有写成Java代码的需求, 请尽量避免使用系统style. 自定义style没问题. style是什么? (参考链接) http://developer.android.com/guide/topics/resources/style-resource.html " A style resource defines

Python&#39;s Coding Style

一个程序员良好的素养可以从他的代码风格里看出. Python官方的开发者指南,PEP8中,列举了Style Guide for Python Code. 摘录The Python's Tutorial中的依依列出. 1.用4空格缩进,而不是tab键. 2.使每行不超过79个字符,目的是小屏幕用户也能很好的阅读. 3.用空一行的方式去把函数,类,和函数中大的代码块分开. 4.如果可能的话,尽量把注释写在一行里. 5.Use docstrings.使用文档字符串.(Ps.这个可得利用好了) 6.在操