BT

如何利用碎片时间提升技术认知与能力? 点击获取答案

Google SoC系列:dcov——Ruby文档覆盖度分析器

| 作者 Werner Schuster 关注 9 他的粉丝 ,译者 高昂 关注 1 他的粉丝 发布于 2007年6月27日. 估计阅读时间: 3 分钟 | CNUTCon 了解国内外一线大厂50+智能运维最新实践案例。

静态分析工具对于保证代码质量来说非常有用,特别是如果这些工具被统一在一个可以自动构建过程中时。比如说rcov项目,可以帮助开发者检查Ruby测试代码的覆盖情况。在Google SoC的支持下,一个名叫dcov的新项目已可以帮助开发者分析Ruby代码的文档覆盖情况。

项目的开发者Jeremy McAnally就此解释道:

Dcov分析项目中的文档,提供(类似于rcov的)文档覆盖程度评价,并且(最终会)提供文档覆盖质量的评价。(分析将会)涉及各个功能部件:类、方法和模块。

覆盖质量分析将会使得dcov项目更为有趣:

目前这只是“代码中是否存在注释?”的问题,当质量分析开始应用时,那么事情将会变得越来越有趣。

检查功能部件是否存在注释是很有用的功能,但是这是否会导致开发者向代码中添加无用注释,目的仅是为了从dcov中得到更好的评级。决定注释是否有用将是相对困难的工作,所以Jeremy将这项功能作为dcov的一个可选择插件部分:

实际上我今天刚重构了代码,让分析器变成独立的、可热插拔的类,这样用户可以随意的选择启用或放弃这个功能模块。我希望我们可以有精通语言分析的志愿者加入进来,帮助我们制定衡量注释质量的标准。

dcov项目的文档输出也将基于现有的Ruby工具实现:

我正在试图为项目代码添加Ruby Reports(Ruport)的支持,这意味着,随着Ruport团队不断发布的新的文档输出格式,我们就可以使用这些不同的格式来输出文档报告。

Ruport是一个可拓展的报表系统,可以获得各种输入源的数据,包括(CSV、ActiveRecord models等)之后生成不同格式的报表(包括PDF、HTML等)。

既然dcov可以分析Ruby代码,那么再了解一下Jeremy为其使用何种工具也将十分有趣:

所有代码都通过RDoc的“parse_files”方法解析,之后我们得到一个经解析的数据结构并进行分析。开始的时候,我试图找到一个可以手工解析(或是使用类似于parse_tree来解析的方法),这会使结构更为明晰,但是我后来发现使用RDoc是个更好的选择:一来RDoc的实现更为简洁;二来RDoc是Ruby标准发布版中的一个部分,所有使用Ruby的人都会安装有RDoc类库。

RDoc通过Code Objects系列对象提供了访问Ruby代码及其相应注释的方法,Code Objects被用来表示类、方法等等,以及它们相应的注释。

目前dcov项目建立在RubyForge之上,并且Jeremy拥有一个Blog站点。同时Jeremy还在InfoQ上撰写有一本电子书“Mr. Neighborly's Humble Little Ruby Book”。

查看英文原文:Google SoC Series: dcov - Ruby documentation coverage analyzer

评价本文

专业度
风格

您好,朋友!

您需要 注册一个InfoQ账号 或者 才能进行评论。在您完成注册后还需要进行一些设置。

获得来自InfoQ的更多体验。

告诉我们您的想法

允许的HTML标签: a,b,br,blockquote,i,li,pre,u,ul,p

当有人回复此评论时请E-mail通知我
社区评论

允许的HTML标签: a,b,br,blockquote,i,li,pre,u,ul,p

当有人回复此评论时请E-mail通知我

允许的HTML标签: a,b,br,blockquote,i,li,pre,u,ul,p

当有人回复此评论时请E-mail通知我

讨论

登陆InfoQ,与你最关心的话题互动。


找回密码....

Follow

关注你最喜爱的话题和作者

快速浏览网站内你所感兴趣话题的精选内容。

Like

内容自由定制

选择想要阅读的主题和喜爱的作者定制自己的新闻源。

Notifications

获取更新

设置通知机制以获取内容更新对您而言是否重要

BT