2022年11月1日

在整個組織中維護幹淨的代碼是工程師的全職工作。優先考慮適應性和開放的溝通會有所幫助。無論是好是壞，醜陋的代碼都是軟件工程世界中無處不在的雜草。當工程師為了快速發展的利益而增加相互依賴和多餘的複雜性時，這是增長的一個令人討厭的副作用。如果不及時處理，這些糾葛就會擴展成數字葛藤，阻礙未來的發展。這種討厭的禍害的“雜草修剪器”是適應性。StackHawk工程副總裁丹·霍普金斯建議說:“做一條變色龍。”“在代碼庫中找到現有技術，並嚐試模仿其風格。”霍普金斯的策略需要適度的謙遜、對巧妙代碼的鑒別力和學習新技巧的動力——這些品質是大多數工程師在他們的工作中與生俱來的。對於尋找簡潔的編碼技術的有遠見的程序員來說，適應的機會常常被融入到工程文化中。 For Elise Shaffer, a software engineer at Red Canary , this opportunity is most present in collaboration, which she sees as a vital stepping stone to beautiful coding practices. “At Red Canary, engineers are encouraged to pair with each other,” Shaffer said. “Pair programming helps us leverage our teammates and their expertise to write the best code we can.” As these engineers affirm in their clean-coding strategies, adaptability becomes a crucial landscaping tool. Built In Colorado sat down with Shaffer and Hopkins to find out more about how their respective companies aim to empower engineers to create pristine code through psychological safety, airtight best practices and open communication. Red Canary is a self-described “security ally” that aims to enable organizations to make an impact without fear of cyber-attack. Elise Shaffer, a software engineer, often uses peer feedback as a litmus test for the clarity of her work. “If a teammate asks me how something works, I know that the code isn’t clear enough to tell its own story,” she said. When it comes to writing clean code, what are some best practices you follow? One of my favorite best practices is to focus on testing and test-driven development. I find that forcing myself to write the tests first gives me more clarity about what I’m building — and reassurance that my tests will catch problems in the future. When a new feature requires that we change the architecture or the structure of the code, my tests help me do that without breaking existing functionality. I also find that communication is super important with the team. I will often create pull requests well in advance of requesting an actual review so I can solicit early feedback about my approach. On the other hand, what are some bad coding habits that you wish every developer would stop doing? Engineers can sometimes lean too much toward fitting within existing design patterns. When we see code, our first instinct is to make the smallest change possible. But, if we have to make that change hundreds of times in a row, we can find that our code becomes indecipherable and difficult to maintain. Engineers can sometimes lean too much toward fitting within existing design patterns.” This is how we get unreadable, nested “if” statements. It’s important to ask: “Is this piece of code still clear with the change I’m adding? Will this be easy or hard to change in the future?” These questions can help us spot problem areas in our code before they arise. Having good automated tests can help us make an appropriate change now in a safe manner. My favorite quote about this is from Kent Beck. He said, “When you have to make a change, first make the change easy. Then, make the easy change.” How does your team make clean code a priority? One of our company values is “We deliver quality.” Delivering quality means we need to make clean code a priority. We use testing and code reviews to make sure that we have clean code. We’ve recently put logging and error-handling standards in place. And our review process helps us get more perspectives on our changes. We schedule biweekly lunch-and-learns that let developers share their experience and expertise with the rest of the developer community at Red Canary.