Since I started my computer science journey, one of the biggest things I have been taught is to write clean code and make sure my code is legible. One of the crucial things I remember learning was making sure my code followed the standards of clean code so that not only the grader could read it but also me in the future.<\/p>\n\n\n\n
The importance of meaningful variable names resonates across various perspectives on clean code. The first chapter in\u00a0Clean Code: A Handbook of Agile Software Craftsmanship<\/em>\u00a0by Robert C. Martin emphasizes the significance of choosing descriptive names for variables. This resonates with the broader notion that clean code should be readable and understandable by developers other than the original author.<\/p>\n\n\n\n One thing I would like to start doing (more often):<\/strong><\/p>\n\n\n\n I want to enhance the communicative aspect of my code by embracing meaningful and expressive variable names. Big Dave Thomas, founder of OTI, stresses the importance of clean code that makes it easy for other developers to enhance it. This involves writing functional code and crafting a narrative that future readers (including myself) can follow effortlessly.<\/p>\n\n\n By adopting more expressive names like width and height, I transform the code into a narrative that effectively communicates its purpose and functionality.<\/p>\n\n\n\n The 3rd chapter from\u00a0Refactoring: Improving the Design of Existing Code\u00a0<\/em>by Martin Fowler highlights the challenges posed by long parameter lists in methods. I commit to refraining from creating methods with excessive parameters to prevent this. Instead, I explore techniques like introducing parameter objects, preserving whole objects, or using other refactorings to keep the parameter lists concise.<\/p>\n\n\n\n One thing I want to avoid doing:<\/strong><\/p>\n\n\n\n I want to avoid doing the “Duplicate Code” smell, where identical or similar codes exist in multiple places in the codebase. As per the reading, duplicated code can lead to maintenance challenges, as changes need to be applied in multiple locations. Refactoring to eliminate duplication can improve code maintainability.<\/p>\n\n\n In this example, the refactored code introduces a constant PI to replace the magic number 3.14 used for calculations. This makes the code more readable and maintainable and avoids the duplication of the magic number.<\/p>\n\n\n\n Incorporating meaningful variable names and avoiding long, convoluted methods aligns with industry leaders’ broader clean code principles. By embracing these practices, I can contribute to a codebase that is functional, readable, maintainable, and a testament to our commitment to code craftsmanship.<\/p>\n","protected":false},"excerpt":{"rendered":" Since I started my computer science journey, one of the biggest things I have been taught is to write clean code and make sure my code is legible. One of the crucial things I remember learning was making sure my code followed the standards of clean code so that not only the grader could read […]<\/p>\n","protected":false},"author":13907,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[1],"tags":[],"class_list":["post-4","post","type-post","status-publish","format-standard","hentry","category-uncategorized"],"_links":{"self":[{"href":"https:\/\/blogs.oregonstate.edu\/capstoneblog2ishanshi\/wp-json\/wp\/v2\/posts\/4","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/blogs.oregonstate.edu\/capstoneblog2ishanshi\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/blogs.oregonstate.edu\/capstoneblog2ishanshi\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/blogs.oregonstate.edu\/capstoneblog2ishanshi\/wp-json\/wp\/v2\/users\/13907"}],"replies":[{"embeddable":true,"href":"https:\/\/blogs.oregonstate.edu\/capstoneblog2ishanshi\/wp-json\/wp\/v2\/comments?post=4"}],"version-history":[{"count":1,"href":"https:\/\/blogs.oregonstate.edu\/capstoneblog2ishanshi\/wp-json\/wp\/v2\/posts\/4\/revisions"}],"predecessor-version":[{"id":6,"href":"https:\/\/blogs.oregonstate.edu\/capstoneblog2ishanshi\/wp-json\/wp\/v2\/posts\/4\/revisions\/6"}],"wp:attachment":[{"href":"https:\/\/blogs.oregonstate.edu\/capstoneblog2ishanshi\/wp-json\/wp\/v2\/media?parent=4"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/blogs.oregonstate.edu\/capstoneblog2ishanshi\/wp-json\/wp\/v2\/categories?post=4"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/blogs.oregonstate.edu\/capstoneblog2ishanshi\/wp-json\/wp\/v2\/tags?post=4"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}\n# Before\ndef calc_area(w, h):\n return w * h\n\n# After\ndef calculate_rectangle_area(width, height):\n return width * height\n<\/pre><\/div>\n\n\n
Avoiding Code Smell<\/h3>\n\n\n\n
\n## Code before\ndef calculate_area(radius):\n return 3.14 * radius * radius\n\ndef calculate_volume(radius, height):\n return 3.14 * radius * radius * height\n\n##Code After\nPI = 3.14\n\ndef calculate_area(radius):\n return PI * radius * radius\n\ndef calculate_volume(radius, height):\n return PI * radius * radius * height\n<\/pre><\/div>\n\n\n
Conclusion<\/h3>\n\n\n\n