Java编程规范

Java编程规范

一、Java关键字

package包

import导入

private私有

protected  保护

public公共

static静态

void声明当前成员方法没有返回值

class类

interface  接口

enum枚举

extends继承

implements 实现

new新建

abstract   抽象

super父类

this当前

boolean布尔型

byte字节型

char字符型

short短整型

int整型

long长整型

float单精度浮点型

double双精度浮点型

final最终

if       如果

else     否则

switch   分支语句结构的引导词

case     用在switch语句之中,表示其中的一个分支

break    跳出循环

continue 从头再来

return   结束当前方法的执行并退出

default默认

while    当

do运行

for为了

try     尝试一个可能抛出异常的程序块

catch捕捉异常

assert断言

finally用于处理异常情况,用来声明一个基本肯定会被执行到的语句块

throw抛出一个异常

throws声明在当前定义的成员方法中所有需要抛出的异常

instanceof   实例

synchronized  同步的

transient    声明不用序列化的成员域

volatile     表明两个或者多个变量必须同步地发生变化

native本地

strictfp     声明单精度或双精度浮点数表达式遵循IEEE754算术规范

二、Java保留字

true     真

false    假

null     空

goto     转到

const    不变的

cast     抛出

future   将来

generic  属性的

inner    内部的

operator 运算符

outer    外部的

rest     休息,剩余的

var      变量

byValue  用…的值

三、Java命名规范

1.使用字母、数字、_、$

2.数字不能放在开头

3.不能是关键字和保留字

4.区分字母大小写

5.没有长度限制

包名 必须全部小写,com.baidu.music

类名 首字母必须大写

接口 首字母必须大写

常量 全部大写,单词之间用_连接

变量 首字母小写,第二个单词起首字母大写

四、Java编码规范

1.每条语句单独占据一行,用英文;结束

2.每个变量单独占据一行

3.局部变量在声明的同时进行初始化

4.多个连续空格被视为一个

5.格式化代码

6.代码简洁易懂

7.注释详细明确

五、Java注释规范

(一)形式统一,内容简明

1、注释形式统一

在整个应用程序中,使用具有一致的标点和结构的样式来构造注释。

2、注释内容准确简洁

内容要简单、明了、含义准确,防止注释的多义性。

(二)基本注释(必须加)

(a) 类(接口)的注释

(b) 构造函数的注释

(c) 方法的注释

(d) 全局变量的注释

(e) 字段/属性的注

备注:简单的代码做简单注释,注释内容不大于10个字即可,另外,持久化对象或VO对象的getter、setter方法不需加注释。

(三)特殊必加注释(必须加)

(a) 典型算法必须有注释。

(b) 在代码不明晰处必须有注释。

(c) 在代码修改处加上修改标识的注释。

(d) 在循环和逻辑分支组成的代码中加注释。

(e) 为他人提供的接口必须加详细注释。

(四)注释格式

1.单行(single-line)注释:“//……”

2.块(block)注释:“/*……*/”

3.文档注释(javadoc):“/**……*/”

(五)文档注释标签

@author    作者

@version   版本

@note      开发笔记

@remark    客户参考

@see       交叉参考

@param     参数

@return    返回值

@since     最早出现的jdk版本

@exception 可能抛出的异常

@throws    异常类及抛出条件

public @interface MyTag { }  新建注释标签

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 159,117评论 4 362
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 67,328评论 1 293
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 108,839评论 0 243
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 44,007评论 0 206
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 52,384评论 3 287
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,629评论 1 219
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,880评论 2 313
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,593评论 0 198
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 34,313评论 1 243
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,575评论 2 246
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 32,066评论 1 260
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,392评论 2 253
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 33,052评论 3 236
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 26,082评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,844评论 0 195
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,662评论 2 274
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,575评论 2 270

推荐阅读更多精彩内容

  • 在上一篇的java编程风格学习(二)中我们学习了一些在Java编码过程中的格式规范,遵循这些规范毋庸置疑是我们的书...
    间阳幕宾阅读 687评论 1 2
  • 源文件编码格式为UTF-8 ASCII水平空格字符(0x20,即空格)是源文件中唯一允许出现的空白字符,这意味着:...
    在路上_80f5阅读 452评论 0 0
  • 说说很有趣,任何情绪都可以在此以说说名义得以发泄。一条说说,一个截图,一次深沉,伤心欲绝,悲痛难忍。楼下评论千...
    贫僧阎辟邪阅读 239评论 0 0
  • When We Two Parted by George Gordon Byron 与伊别离际 译者:花下人 Wh...
    花下人阅读 475评论 0 2
  • 总有一首歌,与你产生共鸣,因为它唱出了你的心声;总有一些歌词触碰到你心底的最柔软处,那是心的所在! “不配再说你爱...
    菇凉你妹啊阅读 590评论 0 0