`
lovefly_zero
  • 浏览: 391978 次
  • 性别: Icon_minigender_1
  • 来自: 株洲
社区版块
存档分类
最新评论

如何保持代码质量–度量代码质量的演变史

    博客分类:
  • Java
阅读更多

序论

       现在应该没有多少人会认为代码质量并不重要。高质量的代码和良好的编码实现方式可以使代码更稳固,且更于维护。统一代码标准可以使代码更容易阅读和理解。测量代码覆盖率也是辨别未测试代码的一种极好方式。本文章的主要内容是有关代码质量的课题,以及它们是如何进化,以及在我们该使用哪些工具来适应软件开发的发展历程。

在这篇文章中,我们将寻求用不同的方法和工具来改善和维持高质量的代码,并且提出有关优秀的编码标准和最佳实践。这些步骤主要包括:

  • 手工代码复查
  • 自动化度量普通构建过程中的代码质量
  • 度量IDE中的代码质量
  • 度量持续集成服务器中的代码质量
  • 度量跨项目的代码质量

手工代码复查 – 艰辛的道路

 

       可以说当下最有效的方法便是让某人用挑剔的眼光,依托大量的经验,以及在这一领域某个问题的扎实理解,并采用友好的方式来复查你的代码。人为代码复查对于传播代码库方面的知识是很好的表达方式,它能辨认设计和架构的缺陷以及bug,指出生涩或者不可读的代码,并且查看并修正哪些本地代码不符合编码标准。事实上,许多重大的问题就只能通过这一双慧眼识别了。

       结对编程能够很好地适用于这种变化。这种结构化方法的另一种尝试就是正式代码检查。但是利用正式的结构化代码检查的主要问题在于,他们需要耗费很多时间,需要相当严格的纪律和结构,并且以可持续的方式进行。

       借助两个方式的工具可帮助你进行代码复查。 一种方式是使用基于Web的代码复查工具,如gerrit(关于git的在线代码复查)和Crucible(Atlassian的在线代码审查工具)等,除此之外,它们使用来创建代码复查的过程更加轻量级和不那么正式。

      另一种方式的工具能帮助你进行更细致的代码复查。诸如CheckstylePMD这样的静态分析工具,能协助辨认与编码标准、命名约定的相关问题和不良编程习惯。在这些问题消除之前,它们将进入代码复查阶段。这样手工审查人员就可以专注于更重要的问题,而不会被一些基本问题诸如不良代码编排或者不合标准的变量命名等来分散注意力。

 

快照视图 – 在你的构建中测量代码质量

 

      代码质量分析工具已经在这一领域存在相当长的时间了。像 CheckstylePMD这样的静态分析工具能够协助执行编码标准(其中在保持你的代码可读性和简洁性发挥重要作用)和最佳实践。FindBugs尝试辨认潜在的编码错误或者不良实践。 像Cobertura 和 Clover这样的代码覆盖率工具能协助隔离未经测试的代码。

      也许你在Maven诞生之前一直都在运用这些工具,但是Maven作为第一流的构建工具,它能把这个些工具都集成进来并自动化其构建过程。事实上,拥有这些工具的Maven插件真的让你没有理由不使用,当然偏见除外。

      Maven还引进了Maven 站点插件,这个创造是具有革命性的。Maven站点生成插件只需很少的配置,就能允许你在一个中心位置(服务器专门站点、Web应用某文件夹)生成一个包含代码质量度量报告的主机。这种做法在开源项目里作为有关项目的一站式技术信息店是非常普遍的。Maven站点的多种代码质量插件可以很容易地报告代码的整理质量或者代码覆盖率指标,并深入到代码这一级以便查看实际问题的详细信息。

 

 

      Maven站点插件能有效地在特定时间点为您的项目生成关于代码质量指标的快照。无论如何,通过Maven能构建强壮的代码质量报告并提供额外的分析功能,正如我们所希望看到的那样,这是在现存代码质量度量领域中更好的工具。

 

即时满足 – 在IDE中的代码质量

 

      基于项目层面的代码质量问题报告对于团队建设而言无疑是最好的-它发出一个强烈的信息:代码质量是非常重要的,它有助于确保人们获取到高质量的代码。项目级别的报告还可以非常有效地用于代码审查会议。

      然而,对于一个经常修正代码质量问题的开发者来说,HTML报告是效率低下的。开发人员最需要的是在代码违反约定或者最佳实践时提供即时反馈。幸运的是,Checkstyle、PMD、Findbugs等等插件已经在Eclipse和其它流行的IDE中存在,同样现在的IDE也有自己内建的代码检查功能,无疑这些功能都是非常有益的。很管用吧!然而值得注意的是,开发者必须在他们的IDE报告和项目报告之间统一编码标准。

 

时间机器 – 随着时间的推移代码质量度量

 

       Maven站点插件作为代码质量度量工具的另一个局限性在于它过于被动。如果你对代码质量度量的要求很高,那么你就应该告诉开发者需认真对待;如果你觉得建立代码标准是值得的,那么就必须坚决执行;如果你对待良好的编程习惯非常严肃,那么你就不应该让没有注释的违规行为获得通过。

       持续集成服务器如Hudson、TeamCity 和Bamboo等都有足够的插件以支持Maven生成代码质量度量报告。具体可通过创建一个作业来专注于代码质量度量。这不仅可以让你报告代码的质量度量,而且还能当构建不稳固时主动通知开发者。比如,Hudson violations pluginHudson Cobertura plugin都能让你为你的代码质量度量定义可接受的阀值,然后配置当构建的作业不能满足这个最低值时停止。毫无疑问,这是一个很好的策略。像Checkstyle的工具也是高度可配置,它通过一个优化规则集更加有效地把问题的数量压制至0,并保持新问题的痕迹不会出现在现有的问题集里。

      您搭建在CI服务器中的代码质量报告还会随着时间的推移来记录历史版本的代码质量度量。



 

 

全局视野 – 让我们拥有你的所有度量!

 

      迄今为止,我们现在还没有看到一个能同时满足跨时间和跨项目的代码质量的工具。然而Sonar做到了这一点。Sonar能给你一个非常全局的视野,生成代码质量的度量,同时深入到源代码级。Sonar适用于任何的Maven项目,并使用Maven代码质量报告插件-不过,它可以把规则聚集到Sonar服务器中,这使得它更容易地跨项目实现规则标准化。

      Sonar同样也可以作为代码质量规则的一个中央参考点。你可以在Sonar中定义一个Checkstyle规则集,然后通过Maven构建(将通过你的CI服务器产生度量)和IDE配置两方面来引用它。



 

      然而,尽管Sonar拥有众多的优点,它仍然只是一个被动报告工具。它不会取代你在CI服务器上专门的代码质量度量构建或者适当的IDE集成。

 

结论 – 积极获取有关代码质量!

 

     代码质量度量是维持健康的项目、减少代码维护成本的重要组成部分。测量代码质量度量和在代码问题上确定最佳实践的静态分析工具并不能取代一个很好的人力复查人,有时候他们进行人工复查要容易得多。集成代码质量度量在您的CI构建中–意味着允许你更好的项目级报告,也让你的代码质量度量更加积极主动。最后,Sonar在能在关于度量的全局范围内提供给你全面的跨项目的、汇总的、深度的代码质量报告。

  • 大小: 24.3 KB
  • 大小: 115.9 KB
  • 大小: 174.6 KB
2
0
分享到:
评论
1 楼 codyzhang 2012-03-09  
支持一下~\(≧▽≦)/~啦啦啦  ,希望看到更多精彩文章.....

相关推荐

    基于Simulink的风火水储联合调频系统中储能SOC对ACE影响的技术分析

    内容概要:本文详细探讨了在Simulink环境中构建的风火水储联合调频系统中,储能系统的荷电状态(SOC)对区域控制偏差(ACE)的影响。文中通过具体案例和MATLAB代码展示了储能系统在不同SOC水平下的表现及其对系统稳定性的作用。同时,文章比较了储能单独调频与风火水储联合调频的效果,强调了储能系统在应对风电波动性和提高系统响应速度方面的重要作用。此外,作者提出了针对SOC变化率的参数整定方法以及多电源协同工作的优化策略,旨在减少ACE波动并确保系统稳定运行。 适合人群:从事电力系统调频研究的专业人士,尤其是熟悉Simulink仿真工具的研究人员和技术人员。 使用场景及目标:适用于希望深入了解储能系统在电力系统调频中作用的研究者和技术人员,目标是通过合理的SOC管理和多电源协同工作,优化调频效果,提高系统稳定性。 其他说明:文章提供了详细的MATLAB代码片段,帮助读者更好地理解和应用所讨论的概念。同时,文中提到的实际案例和仿真结果为理论分析提供了有力支持。

    欧姆龙PLC NJ中大型程序案例:结构化与面向对象编程的深度融合及应用

    内容概要:本文深入探讨了欧姆龙PLC NJ系列中大型程序中结构化编程与面向对象编程的结合及其应用。首先介绍了结构化编程作为程序框架的基础,通过功能块(FB)实现清晰的程序结构和流程控制。接着阐述了面向对象编程的理念,将现实世界的对象映射到程序中,利用类的概念实现模块化和可扩展性。两者结合提高了程序的容错率,增强了程序的稳定性和可维护性。文中通过多个实际案例展示了如何在工业自动化领域中应用这两种编程方法,如电机控制、设备类的创建、异常处理机制、接口实现多态性、配方管理和报警处理等。 适合人群:从事工业自动化领域的工程师和技术人员,尤其是那些希望提升PLC编程技能的人群。 使用场景及目标:适用于需要优化PLC程序结构、提高程序可靠性和可维护性的场合。目标是帮助工程师掌握结构化编程和面向对象编程的技巧,从而写出更加高效、稳定的PLC程序。 其他说明:文章强调了在实际项目中灵活运用两种编程方法的重要性,并提醒读者注意实时性要求高的动作控制应采用结构化编程,而工艺逻辑和HMI交互则更适合面向对象编程。

    matlab与聚类分析

    matlab与聚类分析。根据我国历年职工人数(单位:万人),使用有序样品的fisher法聚类。

    卡尔曼滤波生成航迹测量程序

    卡尔曼滤波生成航迹测量程序

    基于格子玻尔兹曼方法(LBM)的多孔电极浸润特性研究及其Python实现

    内容概要:本文详细介绍了利用格子玻尔兹曼方法(LBM)对多孔电极浸润特性的模拟研究。首先阐述了LBM的基本原理,包括碰撞和迁移两个关键步骤,并提供了相应的Python伪代码。接着讨论了如何处理多孔介质中的固体边界,特别是通过随机算法生成孔隙结构以及结合CT扫描数据进行三维重构的方法。文中还探讨了表面张力、接触角等因素对浸润过程的影响,并给出了具体的数学表达式。此外,文章提到了并行计算的应用,如使用CUDA加速大规模网格计算,以提高模拟效率。最后,作者分享了一些实用技巧,如通过调整松弛时间和润湿性参数来优化模拟效果,并强调了LBM在处理复杂几何结构方面的优势。 适合人群:从事电池研发、材料科学领域的研究人员和技术人员,尤其是关注多孔电极浸润性和电解液扩散机制的人群。 使用场景及目标:适用于希望深入了解多孔电极内部流体动力学行为的研究者,旨在帮助他们更好地理解和预测电极材料的浸润特性,从而改进电池设计和性能。 其他说明:尽管LBM在处理多孔介质方面表现出色,但在某些极端条件下仍需引入额外的修正项。同时,参数的选择和边界条件的设定对最终结果有着重要影响,因此需要谨慎对待。

    基于FPGA和W5500的TCP网络通信:Zynq扩展口开发测试平台(使用Vivado 2019.2纯Verilog实现)

    内容概要:本文详细介绍了在Zynq扩展口上使用FPGA和W5500实现TCP网络通信的过程。作者通过一系列实验和技术手段,解决了多个实际问题,最终实现了稳定的数据传输。主要内容包括:硬件搭建(SPI接口配置)、数据回环处理、压力测试及优化、多路复用扩展以及上位机测试脚本的编写。文中提供了大量Verilog代码片段,展示了如何通过状态机控制SPI通信、优化数据缓存管理、处理中断等问题。 适合人群:对FPGA开发和网络通信感兴趣的工程师,尤其是有一定Verilog编程基础的研发人员。 使用场景及目标:适用于需要在嵌入式系统中实现高效、稳定的TCP通信的应用场景。目标是帮助读者掌握FPGA与W5500结合进行网络通信的具体实现方法和技术细节。 其他说明:文章不仅提供了详细的代码实现,还分享了许多实践经验,如硬件连接注意事项、信号完整性问题的解决方案等。此外,作者还提到了未来的工作方向,如UDP组播和QoS优先级控制的实现。

    python3.10以上 可安装pyside6(类似pyqt),具体安装操作步骤

    python3.10以上 可安装pyside6(类似pyqt),具体安装操作步骤

    基于FDTD仿真的可调谐石墨烯超材料吸收体设计与实现

    内容概要:本文详细介绍了利用有限差分时域法(FDTD)进行可调谐石墨烯超材料吸收体的设计与仿真。文中解释了石墨烯超材料的基本结构(三层“三明治”结构)、关键参数(如化学势、周期、厚度等)及其对吸收性能的影响。同时展示了如何通过调整石墨烯的化学势来实现吸收峰的位置和强度的变化,以及如何优化结构参数以获得最佳的吸收效果。此外,还提供了具体的代码示例,帮助读者理解和重现相关实验结果。 适合人群:从事纳米光子学、超材料研究的专业人士,尤其是对石墨烯基超材料感兴趣的科研工作者和技术开发者。 使用场景及目标:适用于希望深入了解石墨烯超材料的工作原理及其潜在应用场景的研究人员;旨在探索新型可调谐光学器件的设计思路和发展方向。 其他说明:文中不仅分享了理论知识,还包括了许多实践经验,如避免常见错误、提高仿真相关效率的小技巧等。对于想要将研究成果应用于实际产品的团队来说,这些细节非常有价值。

    随机生成2字到10字的中文词组

    随机生成2字,3字,4字,5字,6字,7字,8字,9字,10字的中文词组20个

    【汽车电子电气架构】智能座舱域控平台设计:基于双片龍鷹一号SoC芯片的高性能硬件架构与多模态交互系统构建

    内容概要:本文详细探讨了智能座舱域控设计的发展历程和技术趋势。首先介绍了智能座舱从被动式交互到主动式交互的技术演变,包括硬件和交互方式的进步。随后,文章重点讨论了智能座舱功能发展趋势,涵盖车载显示技术的多屏化、大屏化和高端化,以及SoC芯片的多核异构架构和算力融合,强调了其在智能座舱中的核心作用。此外,还阐述了电子电气架构从分布式向集成化的转型,分析了其面临的挑战和未来趋势。最后,基于当前智能座舱的发展需求,提出了一种基于双片龍鷹一号芯片的新域控平台设计方案,详细描述了其硬件设计实现方案,旨在提供高性能、高可靠性的智能座舱解决方案。 适合人群:汽车电子工程师、智能座舱研发人员及相关领域的技术人员。 使用场景及目标:①帮助读者理解智能座舱的技术发展历程及其未来发展方向;②为智能座舱域控平台的设计和开发提供参考和技术支持;③探讨电子电气架构的转型对汽车行业的影响及应对策略。 其他说明:文章结合实际案例和技术数据,深入浅出地解释了智能座舱的各项技术细节,不仅提供了理论指导,还具有较强的实践意义。通过对智能座舱域控平台的全面剖析,有助于推动智能座舱技术的创新发展,提升用户体验。

    多智能体协同编队控制:无人机编队背后的Python实现与关键技术解析

    内容概要:本文详细介绍了多智能体协同编队控制的技术原理及其应用实例。首先通过生动形象的例子解释了编队控制的核心概念,如一致性算法、虚拟结构法和Leader-Follower模式。接着深入探讨了如何用Python实现基础的一致性控制,以及如何通过调整参数(如Kp、Ka)来优化编队效果。文中还讨论了实际工程中常见的问题,如通信延迟、避障策略和动态拓扑变化,并给出了相应的解决方案。最后,强调了参数调试的重要性,并分享了一些实用技巧,如预测补偿、力场融合算法和分布式控制策略。 适合人群:对多智能体系统、无人机编队控制感兴趣的科研人员、工程师和技术爱好者。 使用场景及目标:适用于希望深入了解多智能体协同编队控制理论并能够将其应用于实际项目的研究人员和开发者。目标是帮助读者掌握编队控制的关键技术和实现方法,提高系统的稳定性和可靠性。 其他说明:文章不仅提供了详细的理论讲解,还附有具体的代码示例,便于读者理解和实践。同时,作者结合自身经验分享了许多宝贵的调试技巧和注意事项,有助于读者在实际应用中少走弯路。

    评估管线钢环焊缝质量及其对氢脆的敏感性.pptx

    评估管线钢环焊缝质量及其对氢脆的敏感性.pptx

    C盘清理bat脚本自动清理C盘垃圾文件

    C盘清理bat脚本自动清理C盘垃圾文件

    GBT21266-2007 辣椒及辣椒制品中辣椒素类物质测定及辣度表示方法

    GBT21266-2007 辣椒及辣椒制品中辣椒素类物质测定及辣度表示方法

    弹跳球 XNA 游戏项目 演示如何使用 C# 在 Visual Studio XNA 中构建类似 arkanoiddx-ball 的游戏

    弹跳球 XNA 游戏项目。演示如何使用 C# 在 Visual Studio XNA 中构建类似 arkanoiddx-ball 的游戏。

    【人形机器人领域】宇树科技人形机器人:技术实力、市场炒作与应用前景分析

    内容概要:文章全面解析了宇树科技人形机器人的发展现状、技术实力、市场炒作现象及其应用前景和面临的挑战。宇树科技成立于2016年,凭借春晚舞台的惊艳亮相和社交媒体的热议迅速走红,其人形机器人具备先进的运动控制算法、传感器技术和仿生结构设计。然而,市场炒作现象如高价租赁、二手市场炒作和虚假宣传等影响了市场秩序。尽管存在炒作,人形机器人在工业、服务和家庭领域仍具广阔前景,但也面临技术升级、成本控制、安全性和政策监管等挑战。 适合人群:对机器人技术、人工智能以及科技发展趋势感兴趣的读者,包括科技爱好者、投资者和相关行业的从业者。 使用场景及目标:①帮助读者了解宇树科技人形机器人的技术特点和发展历程;②揭示市场炒作现象及其影响;③探讨人形机器人的应用前景和面临的挑战。 其他说明:文章强调了宇树科技人形机器人在技术上的突破和市场上的表现,同时也提醒读者关注市场炒作现象带来的风险,呼吁各方共同努力推动人形机器人产业健康发展。

    msvcp140.dll

    msvcp140.dll丢失怎样修复

    光学技术超透镜解决方案全球市场分析:前5强生产商排名及市场份额预测

    超透镜是一种将具有特殊电磁特性的纳米结构、按照一定方式进行排列的二维平面透镜,可实现对入射光振幅、相位、偏振等参量的灵活调控,在镜头模组、全息光学、AR/VR等方面具有重要应用,具有颠覆传统光学行业的潜力。 目前,超透镜解决方案的市场处于起步阶段,企业根据客户的具体需求和应用场景为其定制专用超透镜或超透镜产品。 根据QYResearch最新调研报告显示,预计2031年全球超透镜解决方案市场规模将达到29.26亿美元,未来几年年复合增长率CAGR为79.55%。 全球范围内,超透镜解决方案主要生产商包括Metalenz, Inc., Radiant Opto-Electronics (NIL Technology),迈塔兰斯、纳境科技、山河元景等,其中前五大厂商占有大约77.84%的市场份额。 目前,全球核心厂商主要分布在欧美和亚太地区。 就产品类型而言,目前红外超透镜解决方案是最主要的细分产品,占据大约96.76%的份额。 就产品类型而言,目前消费电子是最主要的需求来源,占据大约36.27%的份额。 主要驱动因素: 独特性能优势:超透镜解决方案具有更轻薄、成本更低、成像更好、更易集成、更高效及更易自由设计等优势。能以微米级厚度实现传统厘米级透镜功能,还可集多个光学元件功能于一身,大幅减小成像系统体积、重量,简化结构并优化性能。 技术创新推动:超透镜解决方案技术不断取得进步,设计技术和工艺水平持续提升,其性能和稳定性得以不断提高。制造工艺方面,电子束光刻等多种技术应用到超透镜解决方案生产中,推动超透镜解决方案向更高分辨率、更高产量、更大面积、更高性能的方向发展。 市场需求增长:消费电子、汽车电子、医疗、工业等众多领域快速发展,对高精度、高性能光学器件需求不断增加。如在手机摄像头中可缩小模组体积、提升成像分辨率和降低成本;在汽车电子领域能提高车载摄像头、激光雷达等传感器性能。

    MATLAB实现新能源并网的电力市场调度优化模型及其应用

    内容概要:本文详细介绍了基于MATLAB和优化工具Gurobi/Cplex实现的新能源并网电力市场调度模型。该模型通过IEEE30节点系统进行仿真,重点探讨了风电接入对传统火电调度的影响。文中展示了关键决策变量如机组启停状态、实时出力以及风电出力的定义方法,并深入解析了目标函数的设计,特别是总成本函数中燃料成本、启停成本、备用成本和弃风惩罚之间的权衡。此外,文章还讨论了直流潮流约束的作用,以及节点电价计算背后的经济学原理。最后,通过对不同情景的模拟实验,验证了模型的有效性和实用性。 适用人群:适用于从事电力系统研究、电力市场运营管理和新能源并网调度的专业人士和技术人员。 使用场景及目标:①帮助理解和掌握新能源并网对电力市场调度的具体影响;②为制定合理的电力市场规则和政策提供理论依据和技术支持;③指导实际电力系统的调度操作,提高系统运行效率和经济效益。 其他说明:文中提供的代码片段和具体实现细节有助于读者更好地理解模型的构造和求解过程。同时,强调了在实际应用中需要注意的问题,如弃风惩罚系数的选择、备用容量的配置等。

    基于Python的二手车爬虫数据可视化分析设计(毕业设计源码)

    用Python开发的爬取二手车网站数据及其分析的程序,爬取的时候采用selenium驱动google浏览器进行数据的抓取,抓取的网页内容传入lxml模块的etree对象HTML方法通过xpath解析DOM树,不过二手车的关键数据比如二手车价格,汽车表显里程数字采用了字体文件加密。据的展示采用pyecharts,它是一个用于生成 Echarts 图表的类库。爬取的数据插入mysql数据库和分析数据读取mysql数据库表都是通过pymysql模块操作。

Global site tag (gtag.js) - Google Analytics