java程序代码书写风格及一些简单注意事项
19页1、1. 风格务必保持一贯性风格务必保持一贯性(Consistent) 一位同胞顶着我的鼻子问,为什么我们的 Java 代码缩进格式非得是这 样,而不能是他那样,他就是喜欢他自己的这一种,因此他写的代码总 是用他自己习惯的风格。结果在 Code Review 里被大家毙掉,责令修 改。因此他是大大地不服。就是风格一贯性问题。其实他的风格,本来 也没有什么问题, 但在项目里, 和其他程序员的程序的风格, 显得扃异, 那就存在问题了。比如这个缩进,又比如变量命名方法,不同的类,不 同的 Methods 里,各自不同,这程序就很难看了。所以一旦你选择了 某种风格,一定要贯彻始终。如果一个项目里规定了一个风格,即便很 不符合你自己的习惯,也要贯彻始终,绝不应该有标新立异。 2. 缩进风格缩进风格(indent) 既然是从缩进说起,就先说说缩进风格;一般来说,象 Java 这样的类 C 语言,都采用缩进风格。而常用的,有四种 A.K runFast(); getBackground(); 在方法的声明部分,通常要提供对方法功能的描述,以及方法中返回值 与参数的说明,例如下面的代码: /* * 显示系
2、统信息方法 * param message 系统信息参数 * return message 返回系统信息 */ public String showMessage (String message) / statements; return message; 如果该方法在软件产品的不断升级中已经不被建议使用了,可以通 过在方法声明注释部分添加关键字deprecated 实现。 1.10.2 变量的命名规则变量的命名规则 变量的命名规则是,除了变量(variable),所有对象的实例 (instance),类(class)与类的常量(constant)的第一个字母应 该小写, 在多个单词混合的情况下第一个单词后的所有单词的第一个字 母大写,其余字母小写的规则之外。变量的第一个字母即使系统允许, 也不要为_或者$。变量名字因该紧凑而有意义。变量的名字应该是易 记忆、易于理解的,即使间隔较长的时间也可以依其名而知其意。另外 单字符的变量名应该尽量避免,除非临时变量,例如,一些整数单字符 临时变量:i,j,k,m,n 等以及单字符变量:c,d,e 等,如下所示的代码: int i; char c
3、; float imageWidth; 1.10.3 常量的命名规则常量的命名规则 Java 中的常量一般采用大写字母单词命名, 单词与单词之间用下划 线(_)加以分割,这符合 ANSI 的常量命名规则,如下所示的代码: static final int MIN_WIDTH = 14; static final int MAX_WIDTH = 1000; static final int GET_THE_MEMORY = 128; MyClass.classMethod(); / 正确 myObject.classMethod(); / 不正确(应该避免) 1.11.3 变量赋值规则变量赋值规则 尽量避免在一个单行语句中将一个变量赋多个值, 这样将使代码变得艰 涩、难懂,例如下面的代码: userName = user1.name = jerry lin; / 这种赋值方式应 尽量避免 尽量避免对一元表达式赋值,例如下面的代码在 Java 中是绝对不 允许的: if (i+ = m+) . 当然可以修改为下面的方式,便可以逃避语法错误,不过这是不被推荐 使用的: if (c+ = d+
4、) != 0) . 尽量避免嵌套赋值,这样会浪费编译器较多的时间,例如下面的代码: d = (a = b + c) + r; 上面的赋值方式应修改为下面的方式: a = b + c; d = a + r; 1.11.4 综合规则综合规则 1括号规则 应尽量使用括号()来界定表达式的结合顺序,避免由于运算符优先 级的问题而导致非主观意图错误, 即使你对运算符优先级比较了解而且 代码看起来也比较清晰, 但是其他程序员看这段代码未必像你一样清楚, 例如下面的代码: if (i = j else return false; 上面的程序有些“受累不讨好”的感觉,应该修改为: return isTrue; 相似的有, if (condition) return x; return y; 应该修改为: return (condition ? x : y); 3特殊注释规则 你可以在程序中通过一些特殊注释来表示你的伪代码,例如,用 EXECUTE 表示该代码有问题但是可执行,用 FIXME 表示代码有问题 切不可执行,例如下面的代码: if (isTrue) / EXECUTE int i = 0;
《java程序代码书写风格及一些简单注意事项》由会员第***分享,可在线阅读,更多相关《java程序代码书写风格及一些简单注意事项》请在金锄头文库上搜索。
校园足球汇报
异甘草酸镁注射液【治疗急性药物性肝损伤】Ⅱ期临床研究总结
云教室课程行政伦理学行政良心
语文S版小学二年级语文下册诺亚方舟课件优质课教学课件
未来中考趋势作文考与练
近年来广东历史试题中考易错点分析与教学启示
搜索推广那些事
小学语文二年级上册红领巾真好说课稿设计(说课设计)
新课标人教版二年级语文上册红领巾真好课件
新课程背景下的高中化学课堂教学改革
危机管理与突发事件应对
背影朱自清教案课件二课时
突发公共卫生事件培训
统计学简史及数据科学中南财经大学
水泥混凝土路面技术现状及发展终
有家真好作文讲评课
西南大学植物造景设计总复习
海外汉语教学新探索在线交流学习平台Goclef
动态黑色背景年终总结模板
孙子的治军之道与现代管理谋略总结
2024-03-27 1页
2024-03-27 10页
2024-03-27 3页
2024-03-27 9页
2024-03-27 30页
2024-03-26 1页
2024-03-26 33页
2024-03-26 2页
2024-03-26 6页
2024-03-26 5页