电子文档交易市场
安卓APP | ios版本
电子文档交易市场
安卓APP | ios版本

java程序代码书写风格及一些简单注意事项

19页
  • 卖家[上传人]:第***
  • 文档编号:60814489
  • 上传时间:2018-11-18
  • 文档格式:PDF
  • 文档大小:169.81KB
  • / 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;

      5、i+; else / FIXME 因为 i 没有被声明 i+; 到此为止,关于 Java 程序设计的代码风格与格式规则就全部讲解 完了,希望你们在自己的代码中尽量应用,开始应用可能不太习惯,但 是只要坚持下去, 相信你会发现采用良好代码风格进行程序设计的种种 好处,并且逐渐会对它产生倾慕与依恋。 小结小结 本章详细地讲解了有关 Java 程序设计风格的知识,其中包括:Java 文件名与文件组织结构,Java 文件注释头, 包的声明与引用,类(class)与接口(interface)的声明,Java 源文件编排格式,Java 程序注释,变量的声明初始 化与放置,Java 程序语句编写规则,空格与空行的应用规则,以及 Java 程序设计中方法、变量与常量的命名规则等相 关知识,本章最后还给出了在 Java 编程实践中的三个规则( 访问实例与类中变量的规则; 引用类中的静态变量 与方法的规则; 变量赋值规则)。通过对上述知识的学习,只要你能够坚持上面的编写规则,仅从代码风格上来讲 你已经具备了编写大师级 Java 代码风格的能力了,这就是你学习本章的收获。要继续向大师级 Java 代码的核心

      6、靠近, 就请继续认真学习本书下面的章节。 这里提提一些注意事项和一些 SUN 没提到但大家常用的方式。 a.a. 用有意义的名字命名变量用有意义的名字命名变量 首先,用完整的英语单词或约定俗成的简写命名你的变量,如: firstName zipCode 如果英语不够好,至少用别人看得懂的拼音命名,如 zhuZhi (住址) 胡乱简写,或者胡乱命名,则没有人看得懂你的变量的含义: fn zc zz b.b. 常量用全大写加下画线命名常量用全大写加下画线命名 Java 里的常量,就是 static final: static final SMTH_BBS=““; c.c. 用复数命名用复数命名 collectioncollection 类变量类变量 collection 包括数组,vector 等。命名时请用复数: customers classMates 也可以用一些修饰词命名: someStudents allDepartments d.d. 循环变量循环变量 一般大家都用 i, j, k 等做循环变量。 e.e. StreamStream 变量变量 一般习惯用in, out作为Str

      7、eam变量, 对应inputStream, outputStream 类。如果即读又写的 ioStream,可以用 inOut。 f.f. 变量的命名习惯变量的命名习惯 习惯 MFC 的人喜欢采用匈牙利命名法(Hungarian Notation)。如果你习 惯这样,尽管用,但注意要和同 Project 的人保持一致。还有些人习惯 C+里的下画线方式,也可以采用。 Hungarian Notation: sFirstName Under Score Style: _firstName 这里提供一个 Hungarian Notation 的前缀命名习惯: int i byte b char c double d float f long l offset off length len Object o String s (or str) Arbitray value v 6. Java 文件格式文件格式 有许多方式定义你的文件语句格式,以下是一个例子: a. 文件头说明 (可无) b. Package 定义 c. 空行 d. Import 语句 e. 空行 f. 类定义 如: packa

      8、ge com.midi; /Java Classes import java.awt.*; import java.io.*; import javax.swing.event.*; /WebLogic Classes import weblogic.internal.*; /* * Blah blah * author midi * version 22.2 */ public class MyFirst extends JFrame . /* * Foo. * author midi * version 38.2 */ class Foo . 7. import 顺序顺序 杂乱无章的顺序,看起来很不顺眼。应该对你要 import 的 classes 归 类,按顺序罗列: a. Java 标准类(java.*) b. Java 扩充类(javax.*) c. 第三方类 d. 你的应用程序的类 而且注意在第三方类里注释它们,说明它们的来源: import java.*; import java.util.Date; import java.util.Enumeration; impor

      9、t javax.sql.*; /Apache Xerces import org.apache.xml.*; import org.apache.xerces.dom.*; /Application classes import com.midi.util.*; 8. Classes 的顺序的顺序 a. Javadoc 注释或者其它文件头注释 b. 类声明 c. Fields 声明 d. 空行 e. 构造函数 f. 空行 g. 方法(不包括 main) h. 空行 i. Inner 类 j. 空行 k. main() 例: /* * This is a simple DOM tree XML parser. * . * author: midi * version: 0.0.1 */ public class MyParser / public constants public static final String TITLE = “MyParser“; public static final String VERSION = “0.0.1“; / Private variables private int iSchemaVersion; /* * Constructor */ public MyParser () iSchemaVersion = 1; /* * Constructor * param. */ public MyParser (iSchemaVersion) this.iSchemaVersion = iSchemaVersion; /* * Initialize the parser. */ public void myInit () throws Exception /* * start the application */ public static void main (String argvs) . 9. Field 定义定义 请遵从以下顺序: a. Public 常量 b. Pu

      《java程序代码书写风格及一些简单注意事项》由会员第***分享,可在线阅读,更多相关《java程序代码书写风格及一些简单注意事项》请在金锄头文库上搜索。

      点击阅读更多内容
    最新标签
    发车时刻表 长途客运 入党志愿书填写模板精品 庆祝建党101周年多体裁诗歌朗诵素材汇编10篇唯一微庆祝 智能家居系统本科论文 心得感悟 雁楠中学 20230513224122 2022 公安主题党日 部编版四年级第三单元综合性学习课件 机关事务中心2022年全面依法治区工作总结及来年工作安排 入党积极分子自我推荐 世界水日ppt 关于构建更高水平的全民健身公共服务体系的意见 空气单元分析 哈里德课件 2022年乡村振兴驻村工作计划 空气教材分析 五年级下册科学教材分析 退役军人事务局季度工作总结 集装箱房合同 2021年财务报表 2022年继续教育公需课 2022年公需课 2022年日历每月一张 名词性从句在写作中的应用 局域网技术与局域网组建 施工网格 薪资体系 运维实施方案 硫酸安全技术 柔韧训练 既有居住建筑节能改造技术规程 建筑工地疫情防控 大型工程技术风险 磷酸二氢钾 2022年小学三年级语文下册教学总结例文 少儿美术-小花 2022年环保倡议书模板六篇 2022年监理辞职报告精选 2022年畅想未来记叙文精品 企业信息化建设与管理课程实验指导书范本 草房子读后感-第1篇 小数乘整数教学PPT课件人教版五年级数学上册 2022年教师个人工作计划范本-工作计划 国学小名士经典诵读电视大赛观后感诵读经典传承美德 医疗质量管理制度 2 2022年小学体育教师学期工作总结 2022年家长会心得体会集合15篇
    关于金锄头网 - 版权申诉 - 免责声明 - 诚邀英才 - 联系我们
    手机版 | 川公网安备 51140202000112号 | 经营许可证(蜀ICP备13022795号)
    ©2008-2016 by Sichuan Goldhoe Inc. All Rights Reserved.