网站首页 > 文章中心 > 其它

java的标准代码

作者:小编 更新时间:2023-10-21 10:52:17 浏览量:292人看过

一个java类标准代码行数范围大概是多少

以1000行为准,超过千行就要考虑类拆分了.

类的代码行数没有特定的行数限制规范.根据实际情况决定.

对于经常使用的java类,代码行数应该尽可能的少,这样能减少java类的加载时间,减少内存频繁占用和回收.如果类过大,java类加载会耗时并且占用内存大.容易引起内存回收.

java软件开发的代码规范

java的标准代码-图1

①.、组织与风格

(1).关键词和操作符之间加适当的空格.

注:如果大家有兴趣可以到安安DIY创作室博客,有相关说明性的文章和解释.

Java 的语法与 C++ 及为相似,那么,你知道 Java 的注释有几种吗?是两种?

// 注释一行

/* ...... */ 注释若干行

java的标准代码-图2

不完全对,除了以上两种之外,还有第三种,文档注释:

/** ...... */ 注释若干行,并写入 javadoc 文档

注释要简单明了.

String userName = null; //用户名

边写代码边注释,修改代码同时修改相应的注释,以保证注释与代码的一致性.

在必要的地方注释,注释量要适中.注释的内容要清楚、明了,含义准确,防止注释二义性.

保持注释与其描述的代码相邻,即注释的就近原则.

对代码的注释应放在其上方相邻位置,不可放在下面.对数据结构的注释应放在其上方相邻位置,不可放在下面;对结构中的每个域的注释应放在此域的右方;

同一结构中不同域的注释要对齐.

变量、常量的注释应放在其上方相邻位置或右方.

全局变量要有较详细的注释,包括对其功能、取值范围、哪些函数或过程存取它以及存取时注意事项等的说明.

/**

* Copy Right Information : Neusoft IIT

* Project : eTrain

* Comments : config path

* Version : 1.01

* Sr Date Modified By Why What is modified

**/

在每个函数或过程的前面要有必要的注释信息,包括:函数或过程名称;功能描述;输入、输出及返回值说明;调用关系及被调用关系说明等

* Description :checkout 提款

* @param Hashtable cart info

* @param OrderBean order info

* @return String

*/

public String checkout(Hashtable htCart,

OrderBean orderBean)

throws Exception{

}

javadoc注释标签语法

@version 对类的说明 标明该类模块的版本

@see 对类、属性、方法的说明 参考转向,也就是相关主题

@param 对方法的说明 对方法中某参数的说明

@return 对方法的说明 对方法返回值的说明

@exception 对方法的说明 对方法可能抛出的异常进行说明

定义这个规范的目的是让项目中所有的文档都看起来像一个人写的,增加可读性,减少项目组中因为换人而带来的损失.(这些规范并不是一定要绝对遵守,但是一定要让程序有良好的可读性)较短的单词可通过去掉元音形成缩写;要不然最后自己写的代码自己都看不懂了,那可不行.

较长的单词可取单词的头几发符的优先级,并用括号明确表达式的操作顺序,避免使用默认优先级.

使用匈牙利表示法

Package 的命名

Package 的名字应该都是由一个小写单词组成.

package com.neu.util

Class 的命名

Class 的名字必须由大写字母开头而其他字母都小写的单词组成,对于所有标识符,其中包含的所有单词都应紧靠在一起,而且大写中间单词的首字母.

public class ThisAClassName{}

Class 变量的命名

变量的名字必须用一个小写字母开头.后面的单词用大写字母开头

userName , thisAClassMethod

Static Final 变量的命名

static Final 变量的名字应该都大写,并且指出完整含义.

*DBConfig PATH

public static final String

DB_CONFIG_FILE_PATH =com.neu.etrain.dbconfig;

参数的命名

参数的名字必须和变量的命名规范一致.

数组的命名

数组应该总是用下面的方式来命名:

byte[] buffer;

而不是:

byte buffer[];

方法的参数

使用有意义的参数命名,如果可能的话,使用和要赋值的字段一样的名字:

SetCounter(int size){

this.size = size;

所有的 Java(*.java) 文件都必须遵守如下的样式规则:

版权信息

版权信息必须在 java 文件的开头,比如:

/*

* All right reserved.

其他不需要出现在 javadoc 的信息也可以包含今天这一节.

Package/Imports

package 行要在 import 行之前,import 中标准的包名要在本地的包名之前,而且按照字母

顺序排列.如果 import 行中包含了同一个包中的不同子目录,则应该用 * 来处理.

package hotlava.net.stats;

import java io.*;

import java.util.Observable;

import hotlava.util.Application;

这里 java.io.* 使用来代替InputStream and OutputStream 的.

Class

此时此刻呢的是类的注释,一般是用来解释类的.

* A class representing a set of packet and byte counters

* It is observable to allow it to be watched, but only

* reports changes when the current set is complete

此时此刻呢是类定义,包含了在不同的行的 extends 和 implements

public class CounterSet

extends Observable

implements Cloneable

Class Fields

此时此刻呢是类的成员变量:

* Packet counters

protected int[] packets;

public 的成员变量必须生成文档(JavaDoc).proceted、private和 package 定义的成

员变量如果名字含义明确的话,可以没有注释.

存取方法

此时此刻呢是类变量的存取的方法.它只是简单的用来将类的变量赋值获取值的话,可以简单的

写在一行上.

* Get the counters

* @return an array containing the statistical data. This array has been

* freshly allocated and can be modified by the caller.

public int[] getPackets() { return copyArray(packets, offset); }

public int[] getBytes() { return copyArray(bytes, offset); }

public int[] getPackets() { return packets; }

public void setPackets(int[] packets) { this.packets = packets; }

其它的方法不要写在一行上

构造函数

此时此刻呢是构造函数,它应该用递增的方式写(比如:参数多的写在后面).

访问类型 (public, private 等.) 和 任何 static, final 或 synchronized 应该在一行

中,并且方法和参数另写一行,这样可以使方法和参数更易读.

public

CounterSet(int size){

克隆方法

如果这个类是可以被克隆的,那么下一步就是 clone 方法:

Object clone() {

try {

CounterSet obj = (CounterSet)super.clone();

obj.packets = (int[])packets.clone();

obj.size = size;

return obj;

}catch(CloneNotSupportedException e) {

throw new InternalError(Unexpected CloneNotSUpportedException: +

e.getMessage());

类方法

下面开始写类的方法:

* Set the packet counters

* (such as when restoring from a database)

protected final

throws IllegalArgumentException

{

//

// Ensure the arrays are of equal size

throw new IllegalArgumentException(Arrays must be of the same size);

toString 方法

无论如何,每一个类都应该定义 toString 方法:

String toString() {

String retval = CounterSet: ;

for (int i = 0; i data.length(); i++) {

retval += data.bytes.toString();

retval += data.packets.toString();

return retval;

main 方法

如果main(String[]) 方法已经定义了, 那么它应该写在类的底部.

避免使用不易理解的数字,用有意义的标识来替代.

不要使用难懂的技巧性很高的语句.

源程序中关系较为紧密的代码应尽可能相邻.

在写代码的时候,从头至尾都应该考虑性能问题.这不是说时间都应该浪费在优化代码上,而是我们时刻应该提醒自己要注意代码的效率.比如:如果没有时间来实现一个高效的算法,那么我们应该在文档中记录下来,以便在以后有空的时候再来实现她.

不是所有的人都同意在写代码的时候应该优化性能这个观点的,他们认为性能优化的问题应该在项目的后期再去考虑,也就是在程序的轮廓已经实现了以后.

不必要的对象构造

不要在循环中构造和释放对象

使用 StringBuffer 对象

在处理 String 的时候要尽量使用 StringBuffer 类,StringBuffer 类是构成 String 类的基础.

String 类将 StringBuffer 类封装了起来,(以花费更多时间为代价)为开发人员提供了一个安全的接口.当我们在构造字符串的时候,我们应该用 StringBuffer 来实现大部分的工作,当工作完成后将 StringBuffer 对象再转换为需要的 String 对象.比如:如果有一个字符串必须不断地在其后添加许多字符来完成构造,那么我们应该使用StringBuffer 对象和她的 append() 方法.如果我们用 String 对象代替StringBuffer 对象的话,会花费许多不必要的创建和释放对象的 CPU 时间.大家可以来安安DIY创作室一起讨论.

避免太多的使用 synchronized 关键字避免不必要的使用关键字 synchronized,应该在必要的时候再使用她,这是一个避免死锁的好方法.

byte 数组转换到 characters

为了将 byte 数组转换到 characters,你可以这么做:

Hello world!.getBytes();

Utility 类

Utility 类(仅仅提供方法的类)应该被申明为抽象的来防止被继承或被初始化.

初始化

下面的代码是一种很好的初始化数组的方法:

objectArguments = new Object[] { arguments };

枚举类型

JAVA 对枚举的支持不好,但是下面的代码是一种很有用的模板:

class Colour {

public static final Colour BLACK = new Colour(0, 0, 0);

public static final Colour RED = new Colour(0xFF, 0, 0);

public static final Colour GREEN = new Colour(0, 0xFF, 0);

public static final Colour BLUE = new Colour(0, 0, 0xFF);

public static final Colour WHITE = new Colour(0xFF, 0xFF, 0xFF);

这种技术实现了RED, GREEN, BLUE 等可以象其他语言的枚举类型一样使用的常量.

他们可以用 '==' 操作符来比较.

但是这样使用有一个缺陷:如果一个用户用这样的方法来创建颜色 BLACK new Colour(0,0,0)

那么这就是另外一个对象,'=='操作符就会产生错误.她的 equal() 方法仍然有效.由于这个原因,这个技术的缺陷最好注明在文档中,或者只在自己的包中使用.

代码样式

代码应该用 unix 的格式,而不是 windows 的(比如:回车变成回车+换行)

文档化

必须用 javadoc 来为类生成文档.不仅因为它是标准,这也是被各种 java 编译器都认可的方法.使用 @author 标记是不被推荐的,因为代码不应该是被个人拥有的.

缩进

页宽

{} 对

if (i0) { i ++ }; // 错误, { 和 } 在同一行

if (i0) {

i ++

}; // 正确, { 单独作为一行

} 语句永远单独作为一行.如果 } 语句应该缩进到与其相对应的 { 那一行相对齐的位置.

括号

左括号和后一个字符之间不应该出现空格, 同样, 右括号和前一个字符之间也不应该出现空格. 下面的例子说明括号和空格的错误及正确使用:

CallProc( AParameter ); // 错误

CallProc(AParameter); // 正确

不要在语句中使用无意义的括号. 括号只应该为达到某种目的而出现在源代码中.下面的例子说明错误和正确的用法:

①编写代码时要注意随时保存,并定期备份,防止由于断电、硬盘损坏等原因造成代码丢失.

①.0、可移植性

Borland Jbulider 不喜欢 synchronized 这个关键字,如果你的断点设在这些关键字的作用域内的话,调试的时候你会发现的断点会到处乱跳,让你不知所措.除非必须,尽量不要使用.

换行

如果需要换行的话,尽量用 println 来代替在字符串中使用\n.

你不要这样:

System.out.print(Hello,world!\n);

要这样:

System.out.println(Hello,world!);

或者你构造一个带换行符的字符串,至少要象这样:

String newline = System.getProperty(line.separator);

System.out.println(Hello world + newline);

PrintStream

PrintStream 已经被不赞成(deprecated)使用,用 PrintWrite 来代替它.

JAVA 请问这个代码的标准写法 应该怎么写

来分析下问题:

? ? ? 要输出的是一个矩阵,对于矩阵来说有两个重要的参数,行和列,如果更灵活一点的话就是矩阵每个点的表示符号,以及列之间的分隔符:

? ? ? 用面向对象的方式来分析问题,这个对象有四个属性,行数,列数,和矩阵中每个点的符号表示及列与列之间的分隔符表示,并且这个类有个行为,就是打印矩阵,所以呢这个需求可以用这样一个类来表示,四个属性,一个行为(方法):

public?class?Matrix?{

private?int?rows;

private?int?cols;

private?char?symbol;

private?String?separator;

public?Matrix(int?rows,?int?cols,?char?symbol,?String?separator)?{

this.cols?=?cols;

this.rows?=?rows;

this.symbol?=?symbol;

java的标准代码-图3

this.separator?=?separator;

public?void?print()?{

StringBuilder?builder?=?new?StringBuilder();

for?(int?i?=?0;?i?rows;?i++)?{

for?(int?j?=?0;?j?cols;?j++)?{

builder.append(symbol);

if?(j?cols?-?1)?{

builder.append(separator);

if?(i?rows?-?1)?{

builder.append("\r\n");

System.out.print(builder.toString());

public?static?void?main(String[]?args){

Matrix?matrix?=?new?Matrix(10,10,'*',"?");

matrix.print();

java编码规范有哪些?

尽量使用完整的英文描述符,采用适用于相关领域的术语,采用大小写混合使名字可读.

JAVA代码规范:

(1)类名首字母应该大写.字段、方法以及对象(句柄)的首字母应小写.对于所有标识符,其中包含的所有单词都应紧靠在一起,而且大写中间单词的首字母.例如:

ThisIsAClassName

thisIsMethodOrFieldName

hashCode()

toString()

clone()(implement Cloneable)

implement Serializable

一个复杂的开关语句:考虑采用"多形"机制

数量众多的方法涉及到类型差别极大的操作:考虑用几个类来分别实现

许多成员变量在特征上有很大的差别:考虑使用几个类

版权声明:倡导尊重与保护知识产权。未经许可,任何人不得复制、转载、或以其他方式使用本站《原创》内容,违者将追究其法律责任。本站文章内容,部分图片来源于网络,如有侵权,请联系我们修改或者删除处理。

编辑推荐

热门文章