代码质量与安全
让《龙威小子》里的宫城先生来教你写代码吧!

自1984年上映以来,《龙威小子(The Karate Kid)》就成为了电影史和流行文化中不可忽视的作品之一,深受观众的喜爱。即使已经过了近40年,它的主题和励志时刻依然深深触动着观众。但令人最难忘的要数两位空手道老师——宫城先生和约翰·克里斯之间的持续对抗。

宫城先生和约翰·克里斯有着截然不同的教学风格。宫城先生注重平衡和纪律,希望通过教育实现个人成长。而约翰·克里斯的特点则是无情、好斗,常常采取恐吓、恐惧的手段和严厉的纪律。两位教师都有各自的成功之处,并拥有忠实的学生,但最终(小心剧透!),宫城先生细心而平衡的方法取得了胜利。

宫城先生的教学风格是成功的关键,因为它不仅仅是简单的执行,而是注重于实际应用和个性化教育,并采用直接的传授方式。他不仅教给学生出色的空手道技能,还给他们传授了持续成长所需的价值观和品格。

但是,宫城先生和清洁代码有什么关系?

当您的目标是成为一个专家(这里特指软件开发)时,考虑向谁寻求指导至关重要。您是喜欢听取有助于提高和完善编码技能的建议,还是喜欢恐吓和胁迫呢?如果可以在发现并解决问题的同时,还能学习并提高编程技巧,那么您不想尝试一下吗?

宫城先生的方法帮助学生内化课程,让他们变得越来越好。同样,您编写“清洁代码”的方法也是如此。那么,我们应该如何将宫城先生的智慧运用到“清洁代码”中,帮助开发人员获得成功呢?这一切都取决于我们如何将“教学”穿插在开发过程中。首先,一起来看看宫成先生秉承的教育理念:

  • 性格培养:宫城先生不仅教授空手道动作,还解释了空手道背后的“原因”,让他的学生能够负责任且道德地应用他们的技能;

  • 个性化教学:宫城先生根据不同的学生量身定制了不同的教学方案,为学生提供所需的关注和指导,让他们充分发挥潜能;

  • 实际应用:宫城先生强调高效、有效且基于实际场景的技巧,培养学生在实际情况中应用技巧的能力,提升他们的自信心;

  • 积极与鼓励的环境:宫城先生在信任和激励的基础上培养积极的关系;

  • 长期关注:宫城先生追求对空手道的理解和欣赏,将其视为个人成长的手段,而不仅仅是胜利的工具。

最终,宫城先生赋予了学生捍卫自己的技能,并传授了成功所必需的价值观和品质。这些原则同样可以应用到开发周期中的教育中。

Sonar的教育理念与宫城先生不谋而合

就像在宫城先生的教学风格中,仅仅练习空手道是不够的一样,Sonar指导开发人员练习“清洁代码”也不仅仅是找到并修复问题,开发人员应该能够找到、理解并修复问题,并学会以最佳方式编写“清洁代码”。

开发人员希望能够保持成长并培训自己的技能,以应对越来越大的挑战。然而,安全问题、Bug和截止日期等现实问题都争夺着宝贵的个人成长时间。就像宫城先生一样,我们希望能够在帮助您解决挑战的同时,还能学习、成长。我们将宫城先生的原则应用到了SonarQube、SonarCloud和SonarLint中:

  • 角色培养:当出现问题时,开发人员可以使用我们的“为什么这是一个问题?”功能快速了解导致问题的原因,并内化指南;

  • 个性化指导:Sonar的教育是具体的,并根据问题进行情境化,帮助开发人员充分发挥潜力;

  • 实际应用:当问题被标记时,Sonar的教育就会出现。我们的“如何修复”功能提供适合您编码框架的代码示例,帮助您应对实际场景;

  • 积极与鼓励的环境:Sonar与您的工作流程集成,并通过结构良好的规则描述,在正确的位置和时间提供您需要的信息;

  • 长期关注:Sonar在规则的“更多信息”部分显示与当前问题相关的有价值的信息。它易于访问,也不会妨碍快速解决问题。

Sonar的目标就是成为您的“清洁代码”导师。我们致力于在帮助您理解问题发生原因的同时,保持友好、直截了当且值得信赖的态度。我们希望帮助您在编写高质量代码的同时轻松学习和成长。

我们从宫城先生的故事中收获到:编写“清洁代码”不代表蛮力和执行,“清洁代码”的实现离不开编写它的开发人员的技能和实力。当您能够真正理解并自信地修复问题时,作为个人贡献者和团队成员的您将得到成长,从而提高交付能力。随着交付能力的提升,您的软件也变得更有价值。从今天开始,Sonar可以帮助您成为更好的开发人员,并在此过程中得到最佳的结果。

来源:https://www.sonarsource.com/blog/what-mr-miyagi-can-teach-about-clean-code/

立即尝试“边写边清洁”解决方案,请联系SonarQube中国官方授权合作伙伴——创实 ,我们提供SonarQube产品的咨询、销售、实施、培训及技术支持服务。