博客
关于我
强烈建议你试试无所不能的chatGPT,快点击我
Java基础篇——编码注释规范
阅读量:5109 次
发布时间:2019-06-13

本文共 916 字,大约阅读时间需要 3 分钟。

1.命名规范

1.标示符

合法标示符包括(大小写字母、数字、下划线_、美元符$),数字不能开头

2.关键字

标示符中不可出现关键字

3.文件名和包名

全部小写

4.接口和类

首字母大写,第一个单词一般为名词

5.常量

常量大写,用"_"下划线分割

6.方法名

遵循驼峰命名法,首单词一般为动词

7.变量

遵循驼峰命名法

2.源文件的组成

头部注释,包的声明,导包,类或接口的声明,常量声明,属性声明,构造器声明,方法声明

其中头部注释为:

/*

 *Classname

 *

 *Version information

 *

 *Date

 *

 *Copyrigt notice

 */

3.注释

实现注释和文档注释

1.实现注释

对文件,方法,数据结构和算法的描述

实现注释的格式:

块(block)

/*......*/

单行(sigle-line)

//

尾端(trailing)

//

行末(end-of-line)

//

2.文档注释

对类、接口、构造器、方法、字段、方法的描述、详细说明和特殊说明

格式:

/**

 *

 */

4.空白行

使用两个空行

.一个源文件的两个片段之间

.类声明和接口声明之间

使用一个空行

.两个方法之间

.方法内的局部变量和方法的第一条语句之间

.块注释和单行注释之间

.一个方法内的两个逻辑段之间

5.换行

一行代码的长度为80,超过长度需要换行

换行位置:

1.逗号后

2.操作符前

3.括号“()”后

新一行与上一行的同一级别的表达式对齐

6.空格

空格的使用位置:

1.表示代码语意上的分隔

2.二元运算符与操作数之间的分隔

3.关键字后与括号后的分隔

4.强制类型转换括号与变量之间的分隔

5.for语句的条件中表达式之间的分隔

7.缩进

四个空格表示一层缩进

8.异常的规范

1.异常明确化

异常要细分

2.异常范围的规定

1.同级的try/catch的异常的范围从小到大是自上而下的

2.嵌套的try/catch的异常的范围从小到大是自内向外的

 

如有遗漏或错误,望指出,谢谢!

 

 

转载于:https://www.cnblogs.com/returnsunshine/p/6306553.html

你可能感兴趣的文章
第一个Spring冲刺周期团队进展报告
查看>>
C++函数基础知识
查看>>
红黑树 c++ 实现
查看>>
Android 获取网络链接类型
查看>>
linux中启动与终止lnmp的脚本
查看>>
gdb中信号的处理[转]
查看>>
LeetCode【709. 转换成小写字母】
查看>>
如何在Access2007中使用日期类型查询数据
查看>>
Jzoj4757 树上摩托
查看>>
CF992E Nastya and King-Shamans(线段树二分+思维)
查看>>
oracle 几个时间函数探究
查看>>
第一个Java Web程序
查看>>
树状数组_一维
查看>>
如果没有按照正常的先装iis后装.net的顺序,可以使用此命令重新注册一下:
查看>>
linux install ftp server
查看>>
嵌入式软件设计第8次实验报告
查看>>
算法和数据结构(三)
查看>>
Ubuntu下的eclipse安装subclipse遇到没有javahl的问题...(2天解决了)
查看>>
alter database databasename set single_user with rollback IMMEDIATE 不成功问题
查看>>
idea 系列破解
查看>>