After a bit of working on things, I tried to write a little code that I just expected would work. \u00a0When what I tried didn’t exist yet on the other object, I got to thinking. \u00a0How many of the things that I just expect to be there are actually written? \u00a0This started a code audit that I initially hoped would be two or three days, but quickly turned into a two week long adventure. \u00a0This process was exactly as tedious and boring as you are probably imagining and involved several rather elaborate tables of check marks in my QubeKwest notebook.<\/p>\n
As it turns out, a lot of my objects were missing a lot of the things I wanted them to have, and some other ones actually had completely different ways of doing the same thing. \u00a0(For example, a clone method instead of a copy constructor.) \u00a0That meant coding things that were missing, recoding things that I felt were weird, removing things that should never have been there in the first place, and adding tests to cover all of the things that changed. \u00a0While I was working on the various audits I was performing, I came up with a few new patterns I wanted in place and added them to my notes. \u00a0I even had a few columns for whether or not the files had all the JavaDocs I wanted them to have.<\/p>\n
I’d like to say this was just a bit of “Hey, my Vector4 should have a static isEqual on it.” followed by coding it and calling it a day, but that’s not really how this process went at all. \u00a0Each time I’d bump into another thing that made me sad, I’d make another list with more check marks. \u00a0This in turn led me to wander into the code again from a different angle. \u00a0For example, once I’d added serialization to my math library, I realized that I originally wanted all of the functions to have both “static” and “with this” versions of all the math functions on all the objects, and that what I had was a bit of pot luck. \u00a0More check lists, more coding things, more writing tests to get code coverage back to where I want it. \u00a0This in turn inspired a test audit that made sure everything was tested correctly and where the tests themselves were named correctly (following the pattern I’d established anyway).<\/p>\n
In the end, after weeks of checking out the code, working on new bits, typing JavaDocs, and adding tests for things I didn’t even realize were missing, I think the math and data packages are in a much better place. \u00a0That makes me happy on a deep fundamentally nerdy level, even if the process of getting there was sort of terrible to have gone through.<\/p>\n","protected":false},"excerpt":{"rendered":"
After a bit of working on things, I tried to write a little code that I just expected would work. \u00a0When what I tried didn’t exist yet on the other object, I got to thinking. \u00a0How many of the things that I just expect to be there are actually written? \u00a0This started a code audit … Continue reading Code Audit<\/span><\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"closed","ping_status":"closed","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[3],"tags":[],"class_list":["post-120","post","type-post","status-publish","format-standard","hentry","category-dev"],"_links":{"self":[{"href":"https:\/\/blog.qubekwest.com\/index.php?rest_route=\/wp\/v2\/posts\/120","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/blog.qubekwest.com\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/blog.qubekwest.com\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/blog.qubekwest.com\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/blog.qubekwest.com\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=120"}],"version-history":[{"count":3,"href":"https:\/\/blog.qubekwest.com\/index.php?rest_route=\/wp\/v2\/posts\/120\/revisions"}],"predecessor-version":[{"id":141,"href":"https:\/\/blog.qubekwest.com\/index.php?rest_route=\/wp\/v2\/posts\/120\/revisions\/141"}],"wp:attachment":[{"href":"https:\/\/blog.qubekwest.com\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=120"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/blog.qubekwest.com\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=120"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/blog.qubekwest.com\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=120"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}