OCLint规则与结果分析

OCLint是用来做c,c++和Objective-c的静态代码分析工具。在OCLint安装和使用中介绍了OCLint的安装和是使用。运行OCLint之后,要根据规则读懂结果,分析和修改代码。
有的时候代码出现的一些警告,并不需要立刻修改,但是有一个警告在哪里看着还是挺别扭的,这个时候会就需要了解如何禁止或者忽略一些规则,来消除警告。

OCLint规则

最新的OCLint中有67个检查的规则
http://docs.oclint.org/en/stable/rules/index.html
主要对针对nil值的检查,cocoa的obj检查,类型转换,空值的检查,简洁语法的检查,参数,size和不使用的参数和变量的检查。
主要分为9大类:

    Basic
    Cocoa
    Convention
    Empty
    Migration
    Naming
    Redundant
    Size
    Unused

之前介绍的的我们可以使用命令:oclint-json-compilation-database-e 参数忽略指定的文件,比如忽略Pods文件夹下面的检查:

oclint-json-compilation-database -e Pods -- -o=report.html

还可以还用 -rc 改变检查规则的默认值:

oclint-json-compilation-database -- -rc=LONG_LINE=200 -o=report.html

如果想禁止某一个规则的使用可以使用命令-disable-rule:

oclint-json-compilation-database -disable-rule=LongLine

这样就可以禁止Size中对LongLine的检查。

OCLint结果分析

OCLint的静态分析结果,警告的级别是从P1,P2,P3依次降低的,可以根据生成的报告找到对应的规则,以及修改建议。
比如下面是一条生成的警告信息:

..../.../SuperLoggerPreviewView.m:165:5:  bitwise operator in conditional [basic|P2] 

..../.../SuperLoggerPreviewView.m:165:5:的意思是产生警告的文件以及对应的行号。

bitwise operator in conditional:描述信息。
[basic|P2]这个信息中basic是指检查规则的类型,对应检查规则的9大类别,P2是警告的级别

可以在Rule Index 的第一个分类Basic中可以找到bitwiseoperatorinconditional,就是需要了解的规则信息:

Rule Index

禁止OCLint的检查

有的时候在已知的情况下一段代码会产生OCLint的警告,但是因为其他的一些原因,我们又不能修改代码,或者还没有找到更好的修改方式的时候,可以在代码中禁止OCLint的检查。

1.注解

可以使用注解的方法禁止OCLint的检查,语法是:

attribute((annotate("oclint:suppress[unused method parameter]")))

比如我们知道一个参数没有使用,而又不想产生警告信息就可以这样写:

- (IBAction)turnoverValueChanged:
    (id) __attribute__((annotate("oclint:suppress[unused method parameter]"))) sender
{
    int i; // won't suppress this one
    [self calculateTurnover];
}

对于方法的注解可以这样写:

bool __attribute__((annotate("oclint:suppress"))) aMethod(int aParameter)
{
    // warnings within this method are suppressed at all
    // like unused aParameter variable and empty if statement
    if (1) {}

    return true;
}

2.!OCLint
也可以通过//!OCLint注释的方式,不让OCLint检查。
比如:

void a() {
    int unusedLocalVariable; //!OCLINT
}

注释要写在对应的行上面才能禁止对应的检查,比如对于空的if/else禁止检查的注释为:

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

推荐阅读更多精彩内容

  • 写在前面 刚入职的时候,博哥交代给我一个任务,让我调研一款叫SonarQube的静态代码分析工具,我当时跪在了Ce...
    雨润听潮阅读 2,239评论 0 5
  • OCLint工具介绍 OCLint是一个静态代码扫描分析工具,可用于提高代码质量和减少潜在的缺陷,目前支持C,C+...
    Lojii阅读 5,939评论 5 5
  • OCLint是一个强大的静态代码分析工具,可以用来提高代码质量,查找潜在的bug,主要针对c,c++和Object...
    姜家志阅读 5,081评论 5 16
  • OCLint是一个强大的静态代码分析工具,可以用来提高代码质量,查找潜在的bug,主要针对c,c++和Object...
    刘应阅读 1,276评论 0 1
  • 成为“练习人”此外,我还坚持认为,当我们在提高自己时,我们才最像是人类。和其他任何动物不同,我们可以有意识地改造自...
    BlCReg阅读 141评论 0 0