分享
 
 
 

Java语言编码规范(三)

王朝java/jsp·作者佚名  2006-01-08
窄屏简体版  字體: |||超大  

如需复制、传播,请附上本声明,谢谢。

原文出处:http://java.sun.com/docs/codeconv/html/CodeConvTOC.doc.html,

译文出处:http://morningspace.51.net/,moyingzz@etang.com

(续)

8 空白(White Space)8.1 空行(Blank Lines)空行将逻辑相关的代码段分隔开,以提高可读性。下列情况应该总是使用两个空行:- 一个源文件的两个片段(section)之间- 类声明和接口声明之间 下列情况应该总是使用一个空行:- 两个方法之间- 方法内的局部变量和方法的第一条语句之间- 块注释(参见"5.1.1")或单行注释(参见"5.1.2")之前- 一个方法内的两个逻辑段之间,用以提高可读性 8.2 空格(Blank Spaces)下列情况应该使用空格:- 一个紧跟着括号的关键字应该被空格分开,例如: while (true) { ... } 注意:空格不应该置于方法名与其左括号之间。这将有助于区分关键字和方法调用。- 空白应该位于参数列表中逗号的后面- 所有的二元运算符,除了".",应该使用空格将之与操作数分开。一元操作符和操作数之间不因该加空格,比如:负号("-")、自增("++")和自减("--")。例如: a += c + d; a = (a + b) / (c * d); while (d++ = s++) { n++; } printSize("size is " + foo + "\n"); - for语句中的表达式应该被空格分开,例如: for (expr1; expr2; expr3) - 强制转型后应该跟一个空格,例如: myMethod((byte) aNum, (Object) x); myMethod((int) (cp + 5), ((int) (i + 3)) + 1); 9 命名规范(Naming Conventions)命名规范使程序更易读,从而更易于理解。它们也可以提供一些有关标识符功能的信息,以助于理解代码,例如,不论它是一个常量,包,还是类。标识符类型命名规则例子包(Packages)一个唯一包名的前缀总是全部小写的ASCII字母并且是一个顶级域名,通常是com,edu,gov,mil,net,org,或1981年ISO 3166标准所指定的标识国家的英文双字符代码。包名的后续部分根据不同机构各自内部的命名规范而不尽相同。这类命名规范可能以特定目录名的组成来区分部门(department),项目(project),机器(machine),或注册名(login names)。com.sun.engcom.apple.quicktime.v2edu.cmu.cs.bovik.cheese类(Classes)命名规则:类名是个一名词,采用大小写混合的方式,每个单词的首字母大写。尽量使你的类名简洁而富于描述。使用完整单词,避免缩写词(除非该缩写词被更广泛使用,像URL,HTML)class Raster;class ImageSprite;接口(Interfaces)命名规则:大小写规则与类名相似interface RasterDelegate;interface Storing;方法(Methods)方法名是一个动词,采用大小写混合的方式,第一个单词的首字母小写,其后单词的首字母大写。run();runFast();getBackground();变量(Variables)除了变量名外,所有实例,包括类,类常量,均采用大小写混合的方式,第一个单词的首字母小写,其后单词的首字母大写。变量名不应以下划线或美元符号开头,尽管这在语法上是允许的。变量名应简短且富于描述。变量名的选用应该易于记忆,即,能够指出其用途。尽量避免单个字符的变量名,除非是一次性的临时变量。临时变量通常被取名为i,j,k,m和n,它们一般用于整型;c,d,e,它们一般用于字符型。char c;int i;float myWidth;实例变量(Instance Variables)大小写规则和变量名相似,除了前面需要一个下划线int _employeeId;String _name;Customer _customer;常量(Constants)类常量和ANSI常量的声明,应该全部大写,单词间用下划线隔开。(尽量避免ANSI常量,容易引起错误)static final int MIN_WIDTH = 4;static final int MAX_WIDTH = 999;static final int GET_THE_CPU = 1;10 编程惯例(Programming Practices)10.1 提供对实例以及类变量的访问控制(Providing Access to Instance and Class Variables)若没有足够理由,不要把实例或类变量声明为公有。通常,实例变量无需显式的设置(set)和获取(gotten),通常这作为方法调用的边缘效应 (side effect)而产生。一个具有公有实例变量的恰当例子,是类仅作为数据结构,没有行为。亦即,若你要使用一个结构(struct)而非一个类(如果java支持结构的话),那么把类的实例变量声明为公有是合适的。10.2 引用类变量和类方法(Referring to Class Variables and Methods)避免用一个对象访问一个类的静态变量和方法。应该用类名替代。例如: classMethod(); //OK AClass.classMethod(); //OK anObject.classMethod(); //AVOID! 10.3 常量(Constants)位于for循环中作为计数器值的数字常量,除了-1,0和1之外,不应被直接写入代码。10.4 变量赋值(Variable Assignments)避免在一个语句中给多个变量赋相同的值。它很难读懂。例如: fooBar.fChar = barFoo.lchar = 'c'; // AVOID! 不要将赋值运算符用在容易与相等关系运算符混淆的地方。例如: if (c++ = d++) { // AVOID! (Java disallows) ... } 应该写成 if ((c++ = d++) != 0) { ... } 不要使用内嵌(embedded)赋值运算符试图提高运行时的效率,这是编译器的工作。例如: d = (a = b + c) + r; // AVOID! 应该写成 a = b + c; d = a + r; 10.5 其它惯例(Miscellaneous Practices)10.5.1 圆括号(Parentheses)一般而言,在含有多种运算符的表达式中使用圆括号来避免运算符优先级问题,是个好方法。即使运算符的优先级对你而言可能很清楚,但对其他人未必如此。你不能假设别的程序员和你一样清楚运算符的优先级。 if (a == b && c == d) // AVOID! if ((a == b) && (c == d)) // RIGHT 10.5.2 返回值(Returning Values)设法让你的程序结构符合目的。例如: if (booleanExpression) { return true; } else { return false; } 应该代之以如下方法: return booleanExpression; 类似地: if (condition) { return x; } return y; 应该写做: return (condition ? x : y); 10.5.3 条件运算符"?"前的表达式(Expressions before '?' in the Conditional Operator)如果一个包含二元运算符的表达式出现在三元运算符" ? : "的"?"之前,那么应该给表达式添上一对圆括号。例如: (x >= 0) ? x : -x; 10.5.4 特殊注释(Special Comments)在注释中使用XXX来标识某些未实现(bogus)的但可以工作(works)的内容。用FIXME来标识某些假的和错误的内容。11 代码范例(Code Examples)11.1 Java源文件范例(Java Source File Example)下面的例子,展示了如何合理布局一个包含单一公共类的Java源程序。接口的布局与其相似。更多信息参见"类和接口声明"以及"文挡注释"。/* * @(#)Blah.java 1.82 99/03/18 * * Copyright (c) 1994-1999 Sun Microsystems, Inc. * 901 San Antonio Road, Palo Alto, California, 94303, U.S.A. * All rights reserved. * * This software is the confidential and proprietary information of Sun * Microsystems, Inc. ("Confidential Information"). You shall not * disclose such Confidential Information and shall use it only in * accordance with the terms of the license agreement you entered into * with Sun. */package java.blah;import java.blah.blahdy.BlahBlah;/** * Class description goes here. * * @version 1.82 18 Mar 1999 * @author Firstname Lastname */public class Blah extends SomeClass { /* A class implementation comment can go here. */ /** classVar1 documentation comment */ public static int classVar1; /** * classVar2 documentation comment that happens to be * more than one line long */ private static Object classVar2; /** instanceVar1 documentation comment */ public Object instanceVar1; /** instanceVar2 documentation comment */ protected int instanceVar2; /** instanceVar3 documentation comment */ private Object[] instanceVar3; /** * ...constructor Blah documentation comment... */ public Blah() { // ...implementation goes here... } /** * ...method doSomething documentation comment... */ public void doSomething() { // ...implementation goes here... } /** * ...method doSomethingElse documentation comment... * @param someParam description */ public void doSomethingElse(Object someParam) { // ...implementation goes here... }}(完)

 
 
 
免责声明:本文为网络用户发布,其观点仅代表作者个人观点,与本站无关,本站仅提供信息存储服务。文中陈述内容未经本站证实,其真实性、完整性、及时性本站不作任何保证或承诺,请读者仅作参考,并请自行核实相关内容。
2023年上半年GDP全球前十五强
 百态   2023-10-24
美众议院议长启动对拜登的弹劾调查
 百态   2023-09-13
上海、济南、武汉等多地出现不明坠落物
 探索   2023-09-06
印度或要将国名改为“巴拉特”
 百态   2023-09-06
男子为女友送行,买票不登机被捕
 百态   2023-08-20
手机地震预警功能怎么开?
 干货   2023-08-06
女子4年卖2套房花700多万做美容:不但没变美脸,面部还出现变形
 百态   2023-08-04
住户一楼被水淹 还冲来8头猪
 百态   2023-07-31
女子体内爬出大量瓜子状活虫
 百态   2023-07-25
地球连续35年收到神秘规律性信号,网友:不要回答!
 探索   2023-07-21
全球镓价格本周大涨27%
 探索   2023-07-09
钱都流向了那些不缺钱的人,苦都留给了能吃苦的人
 探索   2023-07-02
倩女手游刀客魅者强控制(强混乱强眩晕强睡眠)和对应控制抗性的关系
 百态   2020-08-20
美国5月9日最新疫情:美国确诊人数突破131万
 百态   2020-05-09
荷兰政府宣布将集体辞职
 干货   2020-04-30
倩女幽魂手游师徒任务情义春秋猜成语答案逍遥观:鹏程万里
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案神机营:射石饮羽
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案昆仑山:拔刀相助
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案天工阁:鬼斧神工
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案丝路古道:单枪匹马
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案镇郊荒野:与虎谋皮
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案镇郊荒野:李代桃僵
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案镇郊荒野:指鹿为马
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案金陵:小鸟依人
 干货   2019-11-12
倩女幽魂手游师徒任务情义春秋猜成语答案金陵:千金买邻
 干货   2019-11-12
 
推荐阅读
 
 
 
>>返回首頁<<
 
靜靜地坐在廢墟上,四周的荒凉一望無際,忽然覺得,淒涼也很美
© 2005- 王朝網路 版權所有