标签 学习 下的文章

也谈代码行统计

一直在纠结要不要就这个话题写点什么,之前梳理过一些思路,但感觉这个题目似乎没什么大意义。不过将东西憋在肚子里的滋味总是不好受的,最终我还是选择写出来一些,即便它真的没有什么意义^_^。

事情缘于近期领导让我负责的一个内部任务:制定组织内的代码行统计标准并实现标准化的工具。就是这个任务促使了我对代码行统计重新做了一番考量。

对代码行统计的理解

代码行统计这个活动不是软件开发过程中的关键路径活动,它对代码质量、开发进度以及软件价格几乎产生不了什么影响,应该算是个可有可无的东西。

就代码行统计这个活动本身而言,我个人的观点是没有代码行统计不表明不能开发出好软件;有了代码行统计,就一定能开发出高质量软件吗?

不过有一种观点认为:世界的本质是数据。通过数据我们可以发现事物运行的规律。代码行统计则是软件工程中对“数据”要求的产物。过程的好坏需要有数据支 撑,因此代码行统计这个活动成为了人们实现“用数据说话”的一柄利器。在“数据为王”的今天,我们无论如何都不能忽视数据的作用。人们通过数据来反映软件 开发过程中的一些规律性的东西本身也没有什么不妥。另外代码是软件开发过程的最重要成果物,因此围绕着代码的性态,我们用工具做诸多分析,期望从得到的数 据中找寻出一些可以指导和改善我们后续工作的蛛丝马迹。代码行统计提供的多是基础数据,在与其他过程基础数据结合分析后,我们能得到更多的信息。

合理地使用场合

个人觉得下面几个场合对代码行统计的需求是合理的:

* 统计代码总规模
   某个项目、某个模块或又某个版本的代码总规模。

* 代码“成分”统计
   统计空行、注释、代码的行数及占比、重复代码行数及占比等。

* 版本间代码变更差异统计
   两个有关联版本的数据对比统计,获取版本间的有效变更数据情况并作为基础数据提供给后续分析。

一些过程质量指标,诸如千行代码缺陷率等均是以上面这些代码行统计输出的基础数据为基础的。

“误用”

有合理的使用,就有“不合理”的使用 – “误用”。之所以加上引号,是因为至今人们对此见仁见智,尚无定论。以下列举两典型的“误用”。

* 通过代码行统计评估进度

有些组织在项目开始初期,就对成果的规模做了估计,比如10w行代码。然后在过程中使用代码统计工具对项目当前已实现的规模进行统计,并用统计出的数据与 初值的比值作为项目进度的评估参考。个人认为这是种典型的误用。盖茨说过:“用代码行数来衡量编程的进度,就如同用航空器零件的重量来衡量航空飞机的制造 进度一样”。且不提初期的估值有多么的不准确,就代码的行数本身而言,也受到各种因素的影响,比如设计方案、实现者的功力以及编码习惯等。同一个功能,A 实现需要100行代码;换成B就需要10行。

* 通过代码行统计评估程序员绩效

在一些外包公司或外包项目里,尤其是日本人的外包项目里,通过编写代码行的多少来评估程序员绩效的作法是很有市场的。我不能完全否定这种方法的正确性,因 为在日本外包项目中变态的日本人对代码的审核极其严格,并且有着苛刻的编码标准和风格,因此一些胡乱堆砌代码或使用奇技淫巧的代码都会被驳回,因此所有项 目开发者的效率似乎被约束到了一个平均线上。在这个前提下,产出的代码越多,似乎的确表明了这个开发者超出了平均效率,或至少牺牲了不少个人时间来完成项 目中的任务,精神可嘉,绩效被评高似乎也是合情合理的。但除此之外,用代码行多寡来评估程序员绩效显然是不受待见的。

考虑这个“误用”时,我也想模仿盖茨的话做个形象且深刻比喻,最初我写下的是这句话:“用代码行数多少来评估程序员的绩效,就好比用曲子的长短来评估音乐 家的水平,或又好比用画幅的大小来衡量画家的水准,或又好比用电影的时长 来掂量导演的功力!”。但仔细揣摩后发现这句话看起来挺像那么回事,但实际上却是不恰当的。什么是水准、水平或功力,这是衡量人的水平高低的;而绩效则是 一段时间范畴内工作成果的评估; 一个是长期的肯定,一个是阶段性的成绩。我显然是将水平和绩效(阶段性成绩)混为一谈了。高水平的开发者不一定每个周期都会取得高绩效,低水平的开发者也 不是无法取得高绩效的。因此这句话似乎应该改成:“用代码行数多少来评估程序员的绩效,就好比用这首曲子的长短来评估音乐家在这个阶段的水平,或又好比用 画幅的大小来衡量画家的这个阶段水准,或又 好比用电影的时长来掂量导演在这部电影上的功力!”。是不是读起来很别扭啊,反正我是这么觉得的。程序员的成果物是代码,代码好坏优劣对程序员绩效有着直 接影响(虽非充分必要条件),我们不妨替换一下本体来换种说法:“用代码行数多少来评估代码实现的好坏,就好比用曲子的长短来评估曲子的优劣,或又好比用 画幅的大小来衡量画作的高低,或又好比用电影的时长来掂量影片的良莠”!

对用代码行数多少来评估程序员绩效这种事情,我是很反感的,但在国内许多公司里,这种现象却又屡见不鲜。但这种行为背后的动机何在呢?传统工厂中,衡量一 个worker的绩效是相对容易量化,也比较客观的,比如制鞋厂可以用制成鞋子的数量来确定 worker绩效;在汽车组装车间,组装汽车的数量可以作为作为工人们的绩效;在炼钢厂,班组炼出的钢铁的吨数可作为班组成员绩效等等。将代码行数作为程 序员绩效的参考指标也许是一个无奈的方法。之所以想用代码行数,是因为程序员工作中能量化的东西不多,代码行数首当其冲。组织为了尽量减少绩效评定时主观 的成分,增加客观的评价,代码行统计从此被误用了。

代码行统计的高效使用

* 标准统一,工具一致

代码行统计工具有很多,因此执行这个活动时会出现不同人使用的代码行统计工具不一致的情况;并且不同工具对一些指标的定义也许有不同,这会导致收集到的数据存在含义不一致,精确度差的问题。因此高效使用代码行统计工具的一个前提就是(统计)标准统一,工具一致。

* 零干扰

一些传统的代码行统计方法是配置负责人收到统计任务时,将任务分发给各个模块的负责人,由各个模块负责人各自统计,然后反馈给配置负责人汇总。这种方式显 然不那么高效,而且容易引起一些对统计任务的反感情绪。高效的代码行统计最好能做到对开发人员“零干扰”。配置负责人可以通过“自动化”的静默方式收集代 码行数据。当然这需要对一些现成的开源工具做一些包装或二次开发才能做到,个人觉得这种投入是值得的,同时也能避免标准不一,工具不一致的情况。

Python脚本命令行变量的实现

我们知道Make工具是支持命令行变量的,这种手段为我们提供了很好的灵活性,我们可以通过敲入不同的命令行参数来决定Makefile脚本的行为。

make [variable1=value1 variable2=value2 ... ... ]。

#
# Makefile
#

CMODE = 64-bit

ifeq ($(CMODE), 64-bit)
    CFLAGS += -m64
endif
  
all:
    gcc $(CFLAGS) -o foo foo.c

$> make
gcc -m64 -o foo foo.c

$> make CMODE=32-bit
gcc -o foo foo.c

近期我们的一个Python脚本工具也有类似的需求了,但Python脚本原生并不支持这种命令行变量,我们来看看是否可以利用Python提供的机制实现一种可以满足我们需求的命令行变量。

我们的期望结果如下:

$> foo.py fruit=apple

# foo.py

flag = '' #这个定义可以有,也可以没有,如果有,可以理解为默认值

….

if flag == 'apple':
    ….
elif flag == 'orange':
    ….
elif flag == 'banana':
    ….
else:
    ….

Python是动态语言,提供了注入eval、exec等在运行时执行代码的能力。我们要实现命令行变量的机制,离不开这些能力的支持。eval用于求值表达式,而x=y是语句,我们只能用exec。

【#1】

import sys

if __name__ == '__main__':
    c = len(sys.argv)
    if c <= 1:
        print "found zero command variable"
        exit(0)

    exec(sys.argv[1])

    if fruit == 'apple':
        print 'this is apple'
    elif fruit == 'oracle':
        print 'this is orange'
    elif fruit == 'banana':
        print 'this is banana'
    else:
        print 'other fruit'

$> foo.py fruit=apple

Traceback (most recent call last):
  File "./foo.py", line 18, in <module>
    exec(sys.argv[1])
  File "<string>", line 1, in <module>
NameError: name 'apple' is not defined

上面的例子执行后,提示'apple'没有定义。执行foo.py fruit="apple"得到的也是同样的错误。从内部输出来看,无论是fruit=apple还是fruit="apple",exec的参数始终都 是fruit=apple,导致exec抱怨apple这个符号没有定义。

我们打开一个Python命令行交互窗口,做如下测试:

$> python
Python 2.7.3 (default, Aug  1 2012, 05:14:39)
[GCC 4.6.3] on linux2
Type "help", "copyright", "credits" or "license" for more information.
>>> exec("fruit=apple")
Traceback (most recent call last):
  File "<stdin>", line 1, in <module>
  File "<string>", line 1, in <module>
NameError: name 'apple' is not defined
>>> exec("fruit='apple'")
>>> fruit
'apple'
>>> exec("num=1")
>>> num
1

通过这个小实验可以看出,我们不能将命令行参数直接原封不动的传给exec,我们要对其进行一下加工,加工的效果如下:

fruit=apple => fruit='apple'
num=1 => num=1

【2】

import sys

def __convert(source):
    (var, sep, val) = source.partition("=")
    if val.isdigit():
        return source
    return  var + "=" + "\'" + val + "\'"

if __name__ == '__main__':
    c = len(sys.argv)
    if c <= 1:
        print "found zero command variable"
        exit(0)

    exec( __convert(sys.argv[1]))

    if fruit == 'apple':
        print 'this is apple'
    elif fruit == 'orange':
        print 'this is orange'
    elif fruit == 'banana':
        print 'this is banana'
    else:
        print 'other fruit'

__convert函数对命令行的参数做了转换,对于数值类的var直接原封不动的返回,否则对于值为字符串的var,将其val用''包裹起来后返回。我们来测试一下新程序:

$> foo.py fruit=apple
this is apple
$> foo.py fruit=orange
this is orange
$> foo.py fruit=watermelon
other fruit

从输出结果来看,我们的预期是达到了^_^。上面的程序只是示例性质的,Python的exec具有运行时执行动态代码的能力,我们在获得这种强大能力的 同时,也面临着巨大的风险。一旦恶意代码从外部传入被exec执行,将带来严重的后果。因此对于exec要执行的代码务必要预先进行必要的形式校验。

如发现本站页面被黑,比如:挂载广告、挖矿等恶意代码,请朋友们及时联系我。十分感谢! Go语言第一课 Go语言精进之路1 Go语言精进之路2 Go语言编程指南
商务合作请联系bigwhite.cn AT aliyun.com

欢迎使用邮件订阅我的博客

输入邮箱订阅本站,只要有新文章发布,就会第一时间发送邮件通知你哦!

这里是 Tony Bai的个人Blog,欢迎访问、订阅和留言! 订阅Feed请点击上面图片

如果您觉得这里的文章对您有帮助,请扫描上方二维码进行捐赠 ,加油后的Tony Bai将会为您呈现更多精彩的文章,谢谢!

如果您希望通过微信捐赠,请用微信客户端扫描下方赞赏码:

如果您希望通过比特币或以太币捐赠,可以扫描下方二维码:

比特币:

以太币:

如果您喜欢通过微信浏览本站内容,可以扫描下方二维码,订阅本站官方微信订阅号“iamtonybai”;点击二维码,可直达本人官方微博主页^_^:
本站Powered by Digital Ocean VPS。
选择Digital Ocean VPS主机,即可获得10美元现金充值,可 免费使用两个月哟! 著名主机提供商Linode 10$优惠码:linode10,在 这里注册即可免费获 得。阿里云推荐码: 1WFZ0V立享9折!


View Tony Bai's profile on LinkedIn
DigitalOcean Referral Badge

文章

评论

  • 正在加载...

分类

标签

归档



View My Stats