{"id":47,"date":"2004-10-20T21:52:29","date_gmt":"2004-10-20T11:52:29","guid":{"rendered":"http:\/\/thekua.com\/rant\/?p=47"},"modified":"2004-10-20T21:58:58","modified_gmt":"2004-10-20T11:58:58","slug":"the-value-in-checking-your-style","status":"publish","type":"post","link":"https:\/\/thekua.com\/rant\/2004\/10\/the-value-in-checking-your-style\/","title":{"rendered":"The Value in Checking Your Style"},"content":{"rendered":"

Increasing code quality is something that is currently being driven hard in our project. I am a big fan of weeding out code to make way for better smelling things like patterns and easily unit testable code. Many people have attempted to quantify code quality using metrics and a variety of tools to enforce these metrics. Checkstyle is one of these tools that we employ to encourage code quality (I qualify this because using these tools do not automatically equate to high quality code). <\/p>\n

If you haven’t heard of it before, it’s a tool that helps to enforce coding standards in your project (and you should read more here<\/a>). It can be used (and abused by project nazis) to enforce all types of coding standards from the most mediocre of coding formatting standards (have these people not heard of Jalopy<\/a>?) to preventing code that is known to be poor design or quality from being added. <\/p>\n

Take the following block of code which can be picked up by the IllegalInstantiation<\/a> check:<\/p>\n

\/\/ code that creates a new and unnecessary boolean object
\nBoolean isRedundant = new Boolean(true); <\/code><\/p><\/blockquote>\n

Although the JDK allows you do this, it is preferred that the following is used instead:<\/p>\n

\/\/ code that reuses the same reference as Boolean.TRUE
\nBoolean isRendant = Boolean.valueOf(true); <\/code><\/p><\/blockquote>\n

Code formatting standards aside (still a very useful item for consistency and a whole another blog entry together), I believe the biggest value that checkstyle can bring are the custom checks that can be (easily written and) added for a specific project. The value behind custom checks (at least to me) is an obvious one. As a project ages over time, certain standard design patterns are used to approach a particular type of problem. Part of the induction cost of new programmers to a team is the knowledge transfer that happens over time as they are gradually exposed to all of the code base and learn these implict patterns that are littered throughtout the code. Quantifying these standards as custom checks is a less costly, and more reliable way ensuring new programmers do not violate these implicit standards, and more importantly can instantly gain the knowledge from the lessons learned by the current team. <\/p>\n

On the project I am currently on, I contributed a custom check as a sanity check to ensure that whenever a session (think of a database connection) was opened, a corresponding close was called within the same method scope (with the intention of minimising the chances of leaving any sessions open).<\/p>\n

See the following code:<\/p>\n

package com.example.of.custom.checks;<\/code><\/p>\n

import com.puppycrawl.tools.checkstyle.api.Check;<\/code>
\nimport com.puppycrawl.tools.checkstyle.api.TokenTypes;<\/code>
\nimport com.puppycrawl.tools.checkstyle.api.DetailAST;<\/code><\/p>\n

\/**<\/code>
\n * Each method that calls a createSession() method should have a corresponding<\/code>
\n * close call to ensure that the database connection is closed. It is good practice<\/code>
\n * to have the same method that calls the createSession() to call the close() <\/code>
\n * method as well as it makes it easier to see that we do not leak open connections.<\/code>
\n * <\/code>
\n * NOTE: The algorithm for ensuring all opened sessions are closed can probably be improved.<\/code>
\n *\/<\/code>
\npublic class SessionClosingCheck extends Check {<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;\/**<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;* Name of the call to the create session method.<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;*\/<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;public static final String SESSION_CREATE = \"createSession\";<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;\/**<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;* Name of the method that closes the session.<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;*\/<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;public static final String SESSION_CLOSE = \"close\";<\/code><\/p>\n

&nbsp;&nbsp;&nbsp;&nbsp;\/**<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;* Context for a method storing the details about calls to createSession and close.<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;*\/<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;private SessionClosingContext sessionClosingContext;<\/code><\/p>\n

&nbsp;&nbsp;&nbsp;&nbsp;\/**<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;* For each createSession() we increase the call to the numberOfSessions. For each<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;* call to close (as long as it is a session object), we can decrement it.<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;* If we reach the end of the file, and we have more than 0 then we have a problem.<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;*<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;* @return List of tokens that trigger a call to the visitToken method.<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;*\/<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;public int[] getDefaultTokens() {<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;return new int[] {<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;TokenTypes.METHOD_DEF, \/\/ Check based on each method declared.<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;TokenTypes.IDENT, \/\/ for calls to session.close() and createSession()<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;};<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;}<\/code><\/p>\n

&nbsp;&nbsp;&nbsp;&nbsp;\/**<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;* Handle visiting a method and visiting an IDENT token.<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;*\/<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;public void visitToken(DetailAST detailAST) {<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;switch (detailAST.getType()) {<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;case TokenTypes.METHOD_DEF:<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;sessionClosingContext = new SessionClosingContext();<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;sessionClosingContext.visitMethodDef(detailAST);<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;break;<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;case TokenTypes.IDENT:<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\/\/ Only check method calls in a method declaration<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;if (sessionClosingContext != null) {<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;sessionClosingContext.visitIdent(detailAST);<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;}<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;break;<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;}<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;}<\/code><\/p>\n

&nbsp;&nbsp;&nbsp;&nbsp;\/**<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;* When we leave the method declaration, check the context and then log failure of<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;* a check if conditions have not been met.<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;*\/<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;public void leaveToken(DetailAST detailAST) {<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;if (TokenTypes.METHOD_DEF == detailAST.getType()) {<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;if (sessionClosingContext != null && !sessionClosingContext.haveAllSessionsBeenClosed()) {<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;log(detailAST.getLineNo(), \"The count to close() is not more than that of createSession()\");<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;}<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\/\/ Reset the context<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;sessionClosingContext = null;<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;}<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;}<\/code><\/p>\n

&nbsp;&nbsp;&nbsp;&nbsp;\/**<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;* Return the method name given a AST that was found for a MethodDef.<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;*\/<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;private String getMethodName(DetailAST methodAST) {<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;return methodAST.findFirstToken(TokenTypes.IDENT).getText();<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;}<\/code><\/p>\n

&nbsp;&nbsp;&nbsp;&nbsp;\/**<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;* Context class for each method. Within a method definition, we want to keep<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;* track of the number of calls to createSession() and then the number of calls<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;* to close(). We then compare these at the end of a method call to tell whether<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;* or not we have closed all connections we may have opened.<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;*\/<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;private class SessionClosingContext {<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\/\/ Number of calls found for createSession<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;private int sessionCreateCalls = 0;<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\/\/ Number of calls found for close<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;private int sessionCloseCalls = 0;<\/code><\/p>\n

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\/**<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;* Visit the IDENT tokens. In this case we are interested in only the calls<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;* to createSession and close.<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;*\/<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;public void visitIdent(DetailAST identAST) {<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;if (SESSION_CLOSE.equals(identAST.getText())) {<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;sessionCloseCalls++;<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;} else if (SESSION_CREATE.equals(identAST.getText())) {<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;sessionCreateCalls++;<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;}<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;}<\/code><\/p>\n

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\/**<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;* If the createSession is actually a method declaration, we are going to count<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;* an additional call to createSession without ignoring it. This method <\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;* ensures that we don't count these.<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;*\/<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;public void visitMethodDef(DetailAST detailAST) {<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;if (SESSION_CREATE.equals(getMethodName(detailAST))) {<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;sessionCreateCalls--;<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;}<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;}<\/code><\/p>\n

&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;\/**<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;* Check whether or not all sessions have been closed. Ensure that the count to<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;* close() is greater than or equal to the number of session creates.<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;*\/<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;public boolean haveAllSessionsBeenClosed() {<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;return sessionCloseCalls >= sessionCreateCalls;<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;}<\/code>
\n&nbsp;&nbsp;&nbsp;&nbsp;}<\/code>
\n}<\/code>\n<\/p><\/blockquote>\n","protected":false},"excerpt":{"rendered":"

Increasing code quality is something that is currently being driven hard in our project. I am a big fan of weeding out code to make way for better smelling things like patterns and easily unit testable code. Many people have attempted to quantify code quality using metrics and a variety of tools to enforce these […]<\/p>\n","protected":false},"author":3,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[3],"tags":[39],"class_list":["post-47","post","type-post","status-publish","format-standard","hentry","category-technical","tag-work-related"],"yoast_head":"\nThe Value in Checking Your Style - thekua.com@rest<\/title>\n<meta name=\"robots\" content=\"index, follow, max-snippet:-1, max-image-preview:large, max-video-preview:-1\" \/>\n<link rel=\"canonical\" href=\"https:\/\/thekua.com\/rant\/2004\/10\/the-value-in-checking-your-style\/\" \/>\n<link rel=\"next\" href=\"https:\/\/thekua.com\/rant\/2004\/10\/the-value-in-checking-your-style\/2\/\" \/>\n<meta property=\"og:locale\" content=\"en_US\" \/>\n<meta property=\"og:type\" content=\"article\" \/>\n<meta property=\"og:title\" content=\"The Value in Checking Your Style - thekua.com@rest\" \/>\n<meta property=\"og:description\" content=\"Increasing code quality is something that is currently being driven hard in our project. I am a big fan of weeding out code to make way for better smelling things like patterns and easily unit testable code. Many people have attempted to quantify code quality using metrics and a variety of tools to enforce these […]\" \/>\n<meta property=\"og:url\" content=\"https:\/\/thekua.com\/rant\/2004\/10\/the-value-in-checking-your-style\/\" \/>\n<meta property=\"og:site_name\" content=\"thekua.com@rest\" \/>\n<meta property=\"article:published_time\" content=\"2004-10-20T11:52:29+00:00\" \/>\n<meta property=\"article:modified_time\" content=\"2004-10-20T11:58:58+00:00\" \/>\n<meta name=\"author\" content=\"Patrick\" \/>\n<meta name=\"twitter:card\" content=\"summary_large_image\" \/>\n<meta name=\"twitter:label1\" content=\"Written by\" \/>\n\t<meta name=\"twitter:data1\" content=\"Patrick\" \/>\n\t<meta name=\"twitter:label2\" content=\"Est. reading time\" \/>\n\t<meta name=\"twitter:data2\" content=\"9 minutes\" \/>\n<script type=\"application\/ld+json\" class=\"yoast-schema-graph\">{\"@context\":\"https:\\\/\\\/schema.org\",\"@graph\":[{\"@type\":\"Article\",\"@id\":\"https:\\\/\\\/thekua.com\\\/rant\\\/2004\\\/10\\\/the-value-in-checking-your-style\\\/#article\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/thekua.com\\\/rant\\\/2004\\\/10\\\/the-value-in-checking-your-style\\\/\"},\"author\":{\"name\":\"Patrick\",\"@id\":\"https:\\\/\\\/thekua.com\\\/rant\\\/#\\\/schema\\\/person\\\/6de103b28f96be3f1f4dc25db357c6ae\"},\"headline\":\"The Value in Checking Your Style\",\"datePublished\":\"2004-10-20T11:52:29+00:00\",\"dateModified\":\"2004-10-20T11:58:58+00:00\",\"mainEntityOfPage\":{\"@id\":\"https:\\\/\\\/thekua.com\\\/rant\\\/2004\\\/10\\\/the-value-in-checking-your-style\\\/\"},\"wordCount\":403,\"commentCount\":4,\"publisher\":{\"@id\":\"https:\\\/\\\/thekua.com\\\/rant\\\/#\\\/schema\\\/person\\\/6de103b28f96be3f1f4dc25db357c6ae\"},\"keywords\":[\"Work-Related\"],\"articleSection\":[\"Work Related\"],\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"CommentAction\",\"name\":\"Comment\",\"target\":[\"https:\\\/\\\/thekua.com\\\/rant\\\/2004\\\/10\\\/the-value-in-checking-your-style\\\/#respond\"]}]},{\"@type\":\"WebPage\",\"@id\":\"https:\\\/\\\/thekua.com\\\/rant\\\/2004\\\/10\\\/the-value-in-checking-your-style\\\/\",\"url\":\"https:\\\/\\\/thekua.com\\\/rant\\\/2004\\\/10\\\/the-value-in-checking-your-style\\\/\",\"name\":\"The Value in Checking Your Style - thekua.com@rest\",\"isPartOf\":{\"@id\":\"https:\\\/\\\/thekua.com\\\/rant\\\/#website\"},\"datePublished\":\"2004-10-20T11:52:29+00:00\",\"dateModified\":\"2004-10-20T11:58:58+00:00\",\"inLanguage\":\"en-US\",\"potentialAction\":[{\"@type\":\"ReadAction\",\"target\":[\"https:\\\/\\\/thekua.com\\\/rant\\\/2004\\\/10\\\/the-value-in-checking-your-style\\\/\"]}]},{\"@type\":\"WebSite\",\"@id\":\"https:\\\/\\\/thekua.com\\\/rant\\\/#website\",\"url\":\"https:\\\/\\\/thekua.com\\\/rant\\\/\",\"name\":\"thekua.com@rest\",\"description\":\"\",\"publisher\":{\"@id\":\"https:\\\/\\\/thekua.com\\\/rant\\\/#\\\/schema\\\/person\\\/6de103b28f96be3f1f4dc25db357c6ae\"},\"potentialAction\":[{\"@type\":\"SearchAction\",\"target\":{\"@type\":\"EntryPoint\",\"urlTemplate\":\"https:\\\/\\\/thekua.com\\\/rant\\\/?s={search_term_string}\"},\"query-input\":{\"@type\":\"PropertyValueSpecification\",\"valueRequired\":true,\"valueName\":\"search_term_string\"}}],\"inLanguage\":\"en-US\"},{\"@type\":[\"Person\",\"Organization\"],\"@id\":\"https:\\\/\\\/thekua.com\\\/rant\\\/#\\\/schema\\\/person\\\/6de103b28f96be3f1f4dc25db357c6ae\",\"name\":\"Patrick\",\"image\":{\"@type\":\"ImageObject\",\"inLanguage\":\"en-US\",\"@id\":\"https:\\\/\\\/thekua.com\\\/rant\\\/wp-content\\\/uploads\\\/2025\\\/12\\\/pat-kua-head.png\",\"url\":\"https:\\\/\\\/thekua.com\\\/rant\\\/wp-content\\\/uploads\\\/2025\\\/12\\\/pat-kua-head.png\",\"contentUrl\":\"https:\\\/\\\/thekua.com\\\/rant\\\/wp-content\\\/uploads\\\/2025\\\/12\\\/pat-kua-head.png\",\"width\":400,\"height\":400,\"caption\":\"Patrick\"},\"logo\":{\"@id\":\"https:\\\/\\\/thekua.com\\\/rant\\\/wp-content\\\/uploads\\\/2025\\\/12\\\/pat-kua-head.png\"},\"sameAs\":[\"http:\\\/\\\/www.thekua.com\"],\"url\":\"https:\\\/\\\/thekua.com\\\/rant\\\/author\\\/patrick\\\/\"}]}<\/script>\n<!-- \/ Yoast SEO plugin. -->","yoast_head_json":{"title":"The Value in Checking Your Style - thekua.com@rest","robots":{"index":"index","follow":"follow","max-snippet":"max-snippet:-1","max-image-preview":"max-image-preview:large","max-video-preview":"max-video-preview:-1"},"canonical":"https:\/\/thekua.com\/rant\/2004\/10\/the-value-in-checking-your-style\/","next":"https:\/\/thekua.com\/rant\/2004\/10\/the-value-in-checking-your-style\/2\/","og_locale":"en_US","og_type":"article","og_title":"The Value in Checking Your Style - thekua.com@rest","og_description":"Increasing code quality is something that is currently being driven hard in our project. I am a big fan of weeding out code to make way for better smelling things like patterns and easily unit testable code. Many people have attempted to quantify code quality using metrics and a variety of tools to enforce these […]","og_url":"https:\/\/thekua.com\/rant\/2004\/10\/the-value-in-checking-your-style\/","og_site_name":"thekua.com@rest","article_published_time":"2004-10-20T11:52:29+00:00","article_modified_time":"2004-10-20T11:58:58+00:00","author":"Patrick","twitter_card":"summary_large_image","twitter_misc":{"Written by":"Patrick","Est. reading time":"9 minutes"},"schema":{"@context":"https:\/\/schema.org","@graph":[{"@type":"Article","@id":"https:\/\/thekua.com\/rant\/2004\/10\/the-value-in-checking-your-style\/#article","isPartOf":{"@id":"https:\/\/thekua.com\/rant\/2004\/10\/the-value-in-checking-your-style\/"},"author":{"name":"Patrick","@id":"https:\/\/thekua.com\/rant\/#\/schema\/person\/6de103b28f96be3f1f4dc25db357c6ae"},"headline":"The Value in Checking Your Style","datePublished":"2004-10-20T11:52:29+00:00","dateModified":"2004-10-20T11:58:58+00:00","mainEntityOfPage":{"@id":"https:\/\/thekua.com\/rant\/2004\/10\/the-value-in-checking-your-style\/"},"wordCount":403,"commentCount":4,"publisher":{"@id":"https:\/\/thekua.com\/rant\/#\/schema\/person\/6de103b28f96be3f1f4dc25db357c6ae"},"keywords":["Work-Related"],"articleSection":["Work Related"],"inLanguage":"en-US","potentialAction":[{"@type":"CommentAction","name":"Comment","target":["https:\/\/thekua.com\/rant\/2004\/10\/the-value-in-checking-your-style\/#respond"]}]},{"@type":"WebPage","@id":"https:\/\/thekua.com\/rant\/2004\/10\/the-value-in-checking-your-style\/","url":"https:\/\/thekua.com\/rant\/2004\/10\/the-value-in-checking-your-style\/","name":"The Value in Checking Your Style - thekua.com@rest","isPartOf":{"@id":"https:\/\/thekua.com\/rant\/#website"},"datePublished":"2004-10-20T11:52:29+00:00","dateModified":"2004-10-20T11:58:58+00:00","inLanguage":"en-US","potentialAction":[{"@type":"ReadAction","target":["https:\/\/thekua.com\/rant\/2004\/10\/the-value-in-checking-your-style\/"]}]},{"@type":"WebSite","@id":"https:\/\/thekua.com\/rant\/#website","url":"https:\/\/thekua.com\/rant\/","name":"thekua.com@rest","description":"","publisher":{"@id":"https:\/\/thekua.com\/rant\/#\/schema\/person\/6de103b28f96be3f1f4dc25db357c6ae"},"potentialAction":[{"@type":"SearchAction","target":{"@type":"EntryPoint","urlTemplate":"https:\/\/thekua.com\/rant\/?s={search_term_string}"},"query-input":{"@type":"PropertyValueSpecification","valueRequired":true,"valueName":"search_term_string"}}],"inLanguage":"en-US"},{"@type":["Person","Organization"],"@id":"https:\/\/thekua.com\/rant\/#\/schema\/person\/6de103b28f96be3f1f4dc25db357c6ae","name":"Patrick","image":{"@type":"ImageObject","inLanguage":"en-US","@id":"https:\/\/thekua.com\/rant\/wp-content\/uploads\/2025\/12\/pat-kua-head.png","url":"https:\/\/thekua.com\/rant\/wp-content\/uploads\/2025\/12\/pat-kua-head.png","contentUrl":"https:\/\/thekua.com\/rant\/wp-content\/uploads\/2025\/12\/pat-kua-head.png","width":400,"height":400,"caption":"Patrick"},"logo":{"@id":"https:\/\/thekua.com\/rant\/wp-content\/uploads\/2025\/12\/pat-kua-head.png"},"sameAs":["http:\/\/www.thekua.com"],"url":"https:\/\/thekua.com\/rant\/author\/patrick\/"}]}},"_links":{"self":[{"href":"https:\/\/thekua.com\/rant\/wp-json\/wp\/v2\/posts\/47","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/thekua.com\/rant\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/thekua.com\/rant\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/thekua.com\/rant\/wp-json\/wp\/v2\/users\/3"}],"replies":[{"embeddable":true,"href":"https:\/\/thekua.com\/rant\/wp-json\/wp\/v2\/comments?post=47"}],"version-history":[{"count":0,"href":"https:\/\/thekua.com\/rant\/wp-json\/wp\/v2\/posts\/47\/revisions"}],"wp:attachment":[{"href":"https:\/\/thekua.com\/rant\/wp-json\/wp\/v2\/media?parent=47"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/thekua.com\/rant\/wp-json\/wp\/v2\/categories?post=47"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/thekua.com\/rant\/wp-json\/wp\/v2\/tags?post=47"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}