java代码飞检案例输出.pdf

文档名称文档密级
1 类、方法和变量缺少注释
【问题描述】
变量没有注释:
方法没有注释:
类没有注释:
文件名:
起始行:40
上下文:public class workService
【问题解读】
变量、方法缺少注释,影响代码走读效率,对java类没有做注释说明,会导致使用该类的
人不知道这个类的功能是什么
【纠正措施】
在变量、方法和类上面添加必要的注释,方便后来维护者维护理解
【举一反三】
平时开发是严格按照华为java编程规范编码
2016-10-3 华为保密信息,未经授权禁止扩散第 1页, 共 27页
文档名称文档密级
2 代码注释未与上方代码空行隔开
【问题描述】
为了提高代码的可读性,跟层次感,注释应该跟上面的代码空一行紧贴下面代码(以
)
/**
* 获取油机的原始当前告警列表
*
* ***@param dgInfo
* ***@return
*/
public List<OmsAlarm> inalCurAlarms(DGInfo dgInfo)
{
List<String> tempDns = ();
List<OmsAlarm> currentAlarmList =
getDGAlarmsBySiteDn(());
// 告警分2套,原来的告警可以取到subFdn,新的告警取不到,只有Mocid和InsId
if (currentAlarmList != null)
{
……
……
}
return currentAlarmList;
}
在上面的代码中红色字体中的注释没有跟上面代码中空一行或者跟下面代码空一行,都不符
合编码规范。
【问题解读】
为了提高代码的可读性(减少歧义)跟层次感,代码规范要求注释应该跟上面的代码空一行,
紧贴下面代码行。
2016-10-3 华为保密信息,未经授权禁止扩散第 2页, 共 27页
文档名称文档密级
【纠正措施】
根据编码规范,该场景的解决方法如下:
/**
* 获取油机的原始当前告警列表
*
* ***@param dgInfo
* ***@return
*/
public List<OmsAlarm> inalCurAlarms(DGInfo dgInfo)
{
List<String> tempDns = ();
List<OmsAlarm> currentAlarmList =
getDGAlarmsBySiteDn(());
// 告警分2套,原来的告警可以取到subFdn,新的告警取不到,只有Mocid和InsId
if (null != currentAlarmList)
{
……
……
}
return currentAlarmList;
}
【举一反三】
在编码中为了之后的维护,我们要增强代码的可读性我们在编码的过程中应适当加一些注释,
提高代码的层次感,以方便维护人员能更好的维护。
2016-10-3 华为保密信息,未经授权禁止扩散第 3页, 共 27页
文档名称文档密级
3 对象判断是否为空,应该把 Null 放在前面(常量和变量
作比较未把常量放在前面)
【问题描述】
判断一个对象是否为null时,应该把null放在前面如if(null == XXX),null放后面不符合编码规
范()
/**
* 获取油机的原始当前告警列表
*
* ***@param dgInfo
* ***@return
*/
public List<OmsAlarm> inalCurAlarms(DGInfo dgInfo)
{
List<String> tempDns = ();
List<OmsAlarm> currentAlarmList =
getDGAlarmsBySiteDn(());
// 告警分2套,原来的告警可以取到subFdn,新的告警取不到,只有Mocid和InsId
if (currentAlarmList != null)
{
String subFdn = null;
String mocId