{"id":19,"date":"2024-01-20T06:30:25","date_gmt":"2024-01-20T06:30:25","guid":{"rendered":"https:\/\/blogs.oregonstate.edu\/arzumana\/?p=19"},"modified":"2024-01-20T06:30:25","modified_gmt":"2024-01-20T06:30:25","slug":"4-stinky-code","status":"publish","type":"post","link":"https:\/\/blogs.oregonstate.edu\/arzumana\/2024\/01\/20\/4-stinky-code\/","title":{"rendered":"#4 – Stinky Code"},"content":{"rendered":"\n

Quick update on the project – all is going well, and we’ve finally sunk our teeth into concrete tasks over the past week. However, this blog isn’t about that…<\/p>\n\n\n\n

It was nice to get a refresher on code smells this week, as it’s one of those things that’s hard to pinpoint. This<\/a> article from Medium did a good recap of 5 of the most common smells. One in particular, “Blob Class”, actually came up over the past few days in my capstone project. One of my team members was reluctant to add extra methods to our “World” controller, since by that point it contained a mix of code for simulation control and UI. I encouraged them to make the additions at first, thinking little of it at first. The impression did stick, so later on I decided to refactor the code, moving UI controls to a separate class. If my teammate did not voice their concern about the code, I likely would have carried on adding to it, and the class would’ve become long and stinky. This goes to show the benefits of peer review – something the article advocates, and something I aim to do more often in the future.<\/p>\n\n\n\n

On a similar note, this<\/a> article from Reflectoring.io talks about viewing code itself as a form of communication – with other developers. While it’s not something the computer or the end user would see, it’s extremely important to write legible code when working in a team. Having primarily coded alone, it’s something I definitely need to get used to, by dropping some bad habits when it comes to naming conventions. When working alone, using “x” or “num” or even “obj” isn’t too bad, but it’s atrocious when someone else stumbles across those names and have to figure out what they are supposed to represent. Lazy names is something I have to drop – sooner rather than later.<\/p>\n","protected":false},"excerpt":{"rendered":"

Quick update on the project – all is going well, and we’ve finally sunk our teeth into concrete tasks over the past week. However, this blog isn’t about that… It was nice to get a refresher on code smells this week, as it’s one of those things that’s hard to pinpoint. This article from Medium […]<\/p>\n","protected":false},"author":13896,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[1],"tags":[],"class_list":["post-19","post","type-post","status-publish","format-standard","hentry","category-uncategorized"],"_links":{"self":[{"href":"https:\/\/blogs.oregonstate.edu\/arzumana\/wp-json\/wp\/v2\/posts\/19","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/blogs.oregonstate.edu\/arzumana\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/blogs.oregonstate.edu\/arzumana\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/blogs.oregonstate.edu\/arzumana\/wp-json\/wp\/v2\/users\/13896"}],"replies":[{"embeddable":true,"href":"https:\/\/blogs.oregonstate.edu\/arzumana\/wp-json\/wp\/v2\/comments?post=19"}],"version-history":[{"count":1,"href":"https:\/\/blogs.oregonstate.edu\/arzumana\/wp-json\/wp\/v2\/posts\/19\/revisions"}],"predecessor-version":[{"id":20,"href":"https:\/\/blogs.oregonstate.edu\/arzumana\/wp-json\/wp\/v2\/posts\/19\/revisions\/20"}],"wp:attachment":[{"href":"https:\/\/blogs.oregonstate.edu\/arzumana\/wp-json\/wp\/v2\/media?parent=19"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/blogs.oregonstate.edu\/arzumana\/wp-json\/wp\/v2\/categories?post=19"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/blogs.oregonstate.edu\/arzumana\/wp-json\/wp\/v2\/tags?post=19"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}