最新java日志规范实用word文档 23页Word下载.docx
- 文档编号:16063298
- 上传时间:2022-11-18
- 格式:DOCX
- 页数:18
- 大小:23.08KB
最新java日志规范实用word文档 23页Word下载.docx
《最新java日志规范实用word文档 23页Word下载.docx》由会员分享,可在线阅读,更多相关《最新java日志规范实用word文档 23页Word下载.docx(18页珍藏版)》请在冰豆网上搜索。
在函数体
的开始、类和接口的定义、以及if、for、do、while、switch、case语句中的程序
或者static、,synchronized等语句块中都要采用如上的缩进方式。
(1.42+)
示例:
if(a>
b){doStart();
}
规则3较长的语句、表达式或参数(>
80字符)要分成多行书写,长表达式要在低优先级操作
符处划分新行,操作符放在新行之首,划分出的新行要进行适当的缩进,使排版整齐,
语句可读。
示例:
if(logger.isDebugEnabled())
{
logger.debug("
Sessiondestroyed,call-id"
+event.getSession().getCallId());
}
规则4不允许把多个短语句写在一行中,即一行只写一条语句(1.42+)
说明:
阅读代码更加清晰示例:
如下例子不符合规范。
Objecto=newObject();
Objectb=null;
规则5if,for,do,while,case,switch,default等语句自占一行,且if,for,do,while,switch等语句
的执行语句无论多少都要加括号{},case的执行语句中如果定义变量必须加括号{}。
阅读代码更加清晰,减少错误产生示例:
b)
doStart();
casex:
{inti=9;
规则6相对独立的程序块之间、变量说明之后必须加空行。
(1.42+)
说明:
阅读代码更加清晰
if(a>
b)
//此处是空行
return;
规则7在两个以上的关键字、变量、常量进行对等操作时,它们之间的操作符之前、之后或者
前后要加空格;
进行非对等操作时,如果是关系密切的立即操作符(如.),后不应加
空格。
if(a==b)
a*=2;
objectA.doStart();
doStart();
1.1.2建议
建议1类属性和类方法不要交叉放置,不同存取范围的属性或者方法也尽量不要交叉放置。
格式:
类定义
类的公有属性定义
类的保护属性定义
类的私有属性定义
类的公有方法定义
Page2,Total19
类的保护方法定义
类的私有方法定义
建议2修饰词按照指定顺序书写:
[访问权限][static][final]。
publicstaticfinalStringstr=“abc”;
1.2注释
1.2.1规则
规则1源程序注释量必须在30%以上。
由于每个文件的代码注释不一定都可以达到30%,建议以一个系统内部模块作为单位进行检查
规则2包的注释:
写入一个名为package.html的HTML格式的说明文件放入包所在路径。
包的
注释内容:
简述本包的作用、详细描述本包的内容、产品模块名称和版本、公
司版权。
方便JavaDoc收集,方便对包的了解
com/huawei/iin/websmap/comm/package.html
<
html>
body>
p>
一句话简述。
详细描述。
产品模块名称和版本
br>
公司版权信息
/body>
/html>
P>
为WEBSMAP提供通信类,上层业务使用本包的通信类与SMP-B进行通信。
。
IINV100R001WEBSMAP
(C)版权所有201X-201X华为技术有限公司
Page3,Total19
规则3类和接口的注释放在class或者interface关键字之前,import关键字之后。
注
释主要是一句话功能简述与功能详细描述。
类注释使用“/***/”注释方式(1.42+)
方便JavaDoc收集,没有import可放在package之后。
注释可根据需要列出:
作者、内容、功能、与其它类的关系等。
功能详细描述部分说明该类或者接口的功能、作用、使用方法和注意事项,每次修改后增加作者和更新版本号和日期,@since表示从那个版本开始就有这个类或者接口,@deprecated表示不建议使用该类或者接口。
/**
*〈一句话功能简述〉
*〈功能详细描述〉
*@author[作者](必须)
*@see[相关类/方法](可选)
*@since[产品/模块版本](必须)
*@deprecated(可选)
*/
packagem;
importjava.util.*;
*LogManager类集中控制对日志读写的操作。
*全部为静态变量和静态方法,对外提供统一接口。
分配对应日志类型的读写器,
*读取或写入符合条件的日志纪录。
*@author张三,李四,王五
*@seeLogIteraotor
*@seeBasicLog
*@sinceCommonLog1.0
publicclassLogManager
规则4类属性(成员变量)、公有和保护方法注释:
写在类属性、公有和保护方法上面,注释方
式为“/***/”.(1.42+)
*注释内容
privateStringlogType;
publicvoidwrite()
Page4,Total19
规则5公有和保护方法注释内容:
列出方法的一句话功能简述、功能详细描述、输入参数、
输出参数、返回值、异常等。
*@param[参数1][参数1说明]
*@param[参数2][参数2说明]
*@return[返回类型说明]
*@exception/throws[异常类型][异常说明]
*@see[类、类#方法、类#成员]
*@since[起始版本]
*@deprecated
@since表示从那个版本开始就有这个方法,如果是最初版本就存在的方法无需说明;
@exception或throws列出可能仍出的异常;
@deprecated表示不建议使用该方法。
*根据日志类型和时间读取日志。
*分配对应日志类型的LogReader,指定类型、查询时间段、条件和反复器缓冲数,*读取日志记录。
查询条件为null或0的表示没有限制,反复器缓冲数为0读不到日志。
*查询时间为左包含原则,即[startTime,endTime)。
*@paramlogTypeName日志类型名(在配置文件中定义的)
*@paramstartTime查询日志的开始时间
*@paramendTime查询日志的结束时间
*@paramlogLevel查询日志的级别
*@paramuserName查询该用户的日志
*@parambufferNum日志反复器缓冲记录数
*@return结果集,日志反复器
*@since1.2
publicstaticLogIteratorread(StringlogType,DatestartTime,DateendTime,intlogLevel,StringuserName,intbufferNum)
规则6对于方法内部用throw语句抛出的异常,必须在方法的注释中标明,对于所调用的其他
方法所抛出的异常,选择主要的在注释中说明。
对于非RuntimeException,即throws
子句声明会抛出的异常,必须在方法的注释中标明。
异常注释用@exception或@throws表示,在JavaDoc中两者等价,但推荐用@exception标注Runtime异常,@throws标注非Runtime异常。
异常的注释必须说明该异常的含义及什么条件下抛出该异常。
Page5,Total19
篇二:
Java编码规范
Java编码规范
第1章概述.......................................................................................................................................3
第2章重要规范...............................................................................................................................4
第3章类的编写规则.........................................................................................................................6
第4章格式规范...............................................................................................................................7
第5章命名规范.............................................................................................................................17
第6章注释规范.............................................................................................................................23
第7章编程实践.............................................................................................................................27
第8章设计模式快速参考...............................................
- 配套讲稿:
如PPT文件的首页显示word图标,表示该PPT已包含配套word讲稿。双击word图标可打开word文档。
- 特殊限制:
部分文档作品中含有的国旗、国徽等图片,仅作为作品整体效果示例展示,禁止商用。设计者仅对作品中独创性部分享有著作权。
- 关 键 词:
- 最新java日志规范实用word文档 23页 最新 java 日志 规范 实用 word 文档 23
![提示](https://static.bdocx.com/images/bang_tan.gif)