java代码规范

本文详细介绍了Java开发中的编码规范,包括命名、注释、缩进、文件名、声明、句子和编程等方面的标准,旨在提升代码的可读性和一致性。如命名要求类名采用驼峰式,注释使用中文,代码行不超过60字符,每个类文件只包含一个Java类等。
摘要由CSDN通过智能技术生成

Java开发中所要恪守的编码标准大体上有如下7点。命名标准、注释标准、缩进排版标准、文件名标准、声明标准、句子标准以及编程标准。
  1.命名标准
  (1)一切的标示符都只能用ASCⅡ字母(A-Z或a-z)、数字(0-9)和下划线“”。
  (2)一个仅有包名的前缀总是悉数小写的字母。例如:www.tonysun.cc
  (3)类名是一个名词,采用大小写混合的方式,每个单词的首字母大写。例如:Tony。
  (4)接口的大小写规矩与类名类似:例如:Tony。
  (5)办法名是一个动词或动词词组,采用大小写混合的方式,第一个单词的首字母小写,其后单词的首字母大写。例如:setNeekeName(StringneekeName)。
  (6)变量名第一个字母小写,任何中心单词的首字母大写。变量名应简略且可以望文生义,易于回忆。例如:neekeName、neekeAddress。防止单个字符的变量名,除非是一次性的暂时变量。
  (7)常量的声明应该悉数大写,每个单词之间用“
”连接。例如:finalStringWWW_TONY_CN=“www.tonysun.cc”;
  2.注释标准
  (1)注释尽或许运用“//”;关于一切的javadoc的注释则运用“/*/”;而暂时对代码块进行注释尽量运用“//”。
  (2)一切的源文件都应该在开头有一个注释,其中列出文件名、日期和类的功能概述。
  (3)每个办法有必要增加文档注释(类的main()办法除外)。
  (4)每个属性有必要增加注释。
  (5)代码中至少包含15%的注释。
  (6)注释运用中文。
  3.缩进排版标准
  (1)防止一行的长度超越60个字符。
  (2)运用Eclipse的源代码的格式化功能完结代码的缩进排版(Ctrl+Shift+F)。
  4.文件名标准
  (1)一个Java源文件只能存储一个Java类。
  (2)文件名与Java类名相同。
  (3)一个类文件的代码行不超越200行。
  5.声明标准
  (1)一行声明一个变量。
  (2)不要将不同类型变量的声明放在同一行。
  (3)只在代码块的开端处声明变量。
  (4)一切的变量有必要在声明时初始化。
  (5)防止声明的局部变量掩盖上一级声明的变量。
  (6)办法与办法之间以空行分隔。
  6.句子标准
  (1)每行至少包含一条简单句子。
  (2)在return句子中,返回值不运用小括号“()”括起来。
  (3)if句子总是用“{”和“}”括起来。
  (4)在for句子的初始化或更新子句中,防止因运用三个以上变量,而导致复杂度提高。
  (5)当switch的一个case顺着往下执行时(因为没有break句子),一般应在break句子的位置增加注释。
  7.编程标准
  (1)提供对实例以及类变量的public或private拜访操控,尽或许不适用默认值或protected拜访操控。
  (2)防止用一个目标拜访一个类的静态变量或办法。应该用类名替代。
  (3)防止在一个句子中给多个变量赋相同的值。
  (4)用switch()句子完成多路分支。
  (5)假如运用JDBC,则考虑运用java.sql.PreparedStatement,而不是java.sql.Statement。
  (6)用于设置目标状况的办法前缀有必要是set;用于检索一个布尔类型目标状况的办法前缀有必要是is,而用于检索其他办法前缀有必要是get。
  (7)程序中应尽或许少运用数字(或字符),尽或许界说静态变量来阐明该数字(或字符)的含义。程序中需求赋值或比较时,运用前面界说的静态变量。在循环操控中例外。

  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 1
    评论
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值