{"id":82,"date":"2025-08-30T03:55:07","date_gmt":"2025-08-30T03:55:07","guid":{"rendered":"http:\/\/katzcs.com\/?page_id=82"},"modified":"2025-08-30T04:54:05","modified_gmt":"2025-08-30T04:54:05","slug":"readability-expectations","status":"publish","type":"page","link":"http:\/\/katzcs.com\/?page_id=82","title":{"rendered":"Readability Expectations"},"content":{"rendered":"\n<div style=\"height:13px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<h1 class=\"wp-block-heading has-text-align-center\">Readability Expectations<\/h1>\n\n\n\n<div style=\"height:14px\" aria-hidden=\"true\" class=\"wp-block-spacer\"><\/div>\n\n\n\n<div class=\"wp-block-group has-tertiary-background-color has-background has-global-padding is-layout-constrained wp-block-group-is-layout-constrained\" style=\"margin-top:0;margin-bottom:0;padding-top:var(--wp--preset--spacing--50);padding-bottom:var(--wp--preset--spacing--50)\">\n<div class=\"wp-block-columns are-vertically-aligned-center is-layout-flex wp-container-core-columns-is-layout-1a9727ad wp-block-columns-is-layout-flex\" style=\"margin-top:0;margin-bottom:0\">\n<div class=\"wp-block-column is-vertically-aligned-center is-layout-flow wp-block-column-is-layout-flow\">\n<div class=\"wp-block-cover hoverImageWrapper\" style=\"min-height:390px;aspect-ratio:unset;\"><img loading=\"lazy\" decoding=\"async\" width=\"1024\" height=\"576\" class=\"wp-block-cover__image-background wp-image-83 size-large\" alt=\"\" src=\"http:\/\/katzcs.com\/wp-content\/uploads\/2025\/08\/1907616-Martin-Fowler-Quote-Any-fool-can-write-code-that-a-computer-can-1024x576.jpg\" data-object-fit=\"cover\" srcset=\"http:\/\/katzcs.com\/wp-content\/uploads\/2025\/08\/1907616-Martin-Fowler-Quote-Any-fool-can-write-code-that-a-computer-can-1024x576.jpg 1024w, http:\/\/katzcs.com\/wp-content\/uploads\/2025\/08\/1907616-Martin-Fowler-Quote-Any-fool-can-write-code-that-a-computer-can-300x169.jpg 300w, http:\/\/katzcs.com\/wp-content\/uploads\/2025\/08\/1907616-Martin-Fowler-Quote-Any-fool-can-write-code-that-a-computer-can-768x432.jpg 768w, http:\/\/katzcs.com\/wp-content\/uploads\/2025\/08\/1907616-Martin-Fowler-Quote-Any-fool-can-write-code-that-a-computer-can-1536x864.jpg 1536w, http:\/\/katzcs.com\/wp-content\/uploads\/2025\/08\/1907616-Martin-Fowler-Quote-Any-fool-can-write-code-that-a-computer-can-2048x1152.jpg 2048w\" sizes=\"auto, (max-width: 1024px) 100vw, 1024px\" \/><span aria-hidden=\"true\" class=\"wp-block-cover__background has-background-dim-10 has-background-dim\" style=\"background-color:#3e3f3c\"><\/span><div class=\"wp-block-cover__inner-container is-layout-flow wp-block-cover-is-layout-flow\">\n<p class=\"has-text-align-center has-large-font-size\"><\/p>\n<\/div><\/div>\n<\/div>\n\n\n\n<div class=\"wp-block-column is-vertically-aligned-center is-layout-flow wp-block-column-is-layout-flow\">\n<p class=\"has-highlighted\">Programming languages have grammar rules just like human languages. Syntax rules are requirements &#8212; the code will not work unless you follow them. Style or &#8220;best practice&#8221; rules allow for good coding and consistent readability.<\/p>\n\n\n\n<p style=\"line-height:1.6\">In order to be a good programmer your code should have good readability!<\/p>\n<\/div>\n<\/div>\n\n\n\n<div class=\"wp-block-columns are-vertically-aligned-center is-layout-flex wp-container-core-columns-is-layout-702decc0 wp-block-columns-is-layout-flex\" style=\"margin-top:0;margin-bottom:0;padding-top:var(--wp--preset--spacing--50)\">\n<div class=\"wp-block-column is-vertically-aligned-center is-layout-flow wp-block-column-is-layout-flow\">\n<h2 class=\"wp-block-heading\" style=\"font-size:clamp(25.014px, 1.563rem + ((1vw - 3.2px) * 1.733), 42px);font-style:normal;font-weight:700;line-height:1.2\">General Guidelines<\/h2>\n\n\n\n<p>For any variables\/functions\/classes\/etc you are naming, use descriptive names whenever reasonable. <\/p>\n\n\n\n<ul class=\"wp-block-list\">\n<li>Variables\n<ul class=\"wp-block-list\">\n<li><a href=\"http:\/\/katzcs.com\/?page_id=94\" data-type=\"page\" data-id=\"94\">When to create them<\/a><\/li>\n\n\n\n<li><a href=\"http:\/\/katzcs.com\/?page_id=100\" data-type=\"page\" data-id=\"100\">How to name them<\/a><\/li>\n<\/ul>\n<\/li>\n\n\n\n<li><a href=\"http:\/\/katzcs.com\/?page_id=105\" data-type=\"page\" data-id=\"105\">Comments<\/a><\/li>\n\n\n\n<li>Whitespace<\/li>\n\n\n\n<li>Code Organization<\/li>\n\n\n\n<li>Miscellaneous\n<ul class=\"wp-block-list\">\n<li>Pet Peeves<\/li>\n<\/ul>\n<\/li>\n<\/ul>\n<\/div>\n\n\n\n<div class=\"wp-block-column is-vertically-aligned-center is-layout-flow wp-block-column-is-layout-flow\">\n<figure class=\"wp-block-image is-resized is-style-rounded is-style-rounded--1\"><img loading=\"lazy\" decoding=\"async\" width=\"650\" height=\"649\" src=\"http:\/\/katzcs.com\/wp-content\/uploads\/2025\/08\/readable_image.jpg\" alt=\"\" class=\"wp-image-86\" style=\"width:397px;height:auto\" srcset=\"http:\/\/katzcs.com\/wp-content\/uploads\/2025\/08\/readable_image.jpg 650w, http:\/\/katzcs.com\/wp-content\/uploads\/2025\/08\/readable_image-300x300.jpg 300w, http:\/\/katzcs.com\/wp-content\/uploads\/2025\/08\/readable_image-150x150.jpg 150w\" sizes=\"auto, (max-width: 650px) 100vw, 650px\" \/><\/figure>\n<\/div>\n<\/div>\n<\/div>\n\n\n\n<div class=\"wp-block-group has-global-padding is-layout-constrained wp-container-core-group-is-layout-b2082ebc wp-block-group-is-layout-constrained\" style=\"margin-top:0;margin-bottom:0;padding-top:100px;padding-right:20px;padding-bottom:100px;padding-left:20px\">\n<div class=\"wp-block-columns are-vertically-aligned-center is-layout-flex wp-container-core-columns-is-layout-9cad5244 wp-block-columns-is-layout-flex\" style=\"margin-top:0;margin-bottom:0\">\n<div class=\"wp-block-column is-vertically-aligned-center is-layout-flow wp-block-column-is-layout-flow\">\n<div class=\"wp-block-cover is-light hoverImageWrapper\" style=\"border-radius:10px;min-height:427px;aspect-ratio:unset;\"><img loading=\"lazy\" decoding=\"async\" width=\"1024\" height=\"683\" class=\"wp-block-cover__image-background wp-image-88 size-large\" alt=\"\" src=\"http:\/\/katzcs.com\/wp-content\/uploads\/2025\/08\/language_logos-1024x683.png\" data-object-fit=\"cover\" srcset=\"http:\/\/katzcs.com\/wp-content\/uploads\/2025\/08\/language_logos-1024x683.png 1024w, http:\/\/katzcs.com\/wp-content\/uploads\/2025\/08\/language_logos-300x200.png 300w, http:\/\/katzcs.com\/wp-content\/uploads\/2025\/08\/language_logos-768x512.png 768w, http:\/\/katzcs.com\/wp-content\/uploads\/2025\/08\/language_logos.png 1536w\" sizes=\"auto, (max-width: 1024px) 100vw, 1024px\" \/><span aria-hidden=\"true\" class=\"wp-block-cover__background has-background-dim-0 has-background-dim\" style=\"background-color:#f4f1ec\"><\/span><div class=\"wp-block-cover__inner-container has-global-padding is-layout-constrained wp-block-cover-is-layout-constrained\">\n<p class=\"has-text-align-center has-large-font-size\"><\/p>\n<\/div><\/div>\n<\/div>\n\n\n\n<div class=\"wp-block-column is-vertically-aligned-center is-layout-flow wp-block-column-is-layout-flow\">\n<h3 class=\"wp-block-heading\" style=\"padding-bottom:var(--wp--preset--spacing--30);font-size:clamp(25.014px, 1.563rem + ((1vw - 3.2px) * 1.733), 42px);font-style:normal;font-weight:700;line-height:1.2\">Check my readability expectations for the language you are using!<\/h3>\n\n\n\n<div class=\"wp-block-buttons is-content-justification-space-between is-layout-flex wp-container-core-buttons-is-layout-8f3c3dcc wp-block-buttons-is-layout-flex\" style=\"margin-top:40px\">\n<div class=\"wp-block-button\"><a class=\"wp-block-button__link has-primary-background-color has-background wp-element-button\" style=\"border-radius:0px\">C++<\/a><\/div>\n\n\n\n<div class=\"wp-block-button\"><a class=\"wp-block-button__link has-primary-background-color has-background wp-element-button\" style=\"border-radius:0px\">Java<\/a><\/div>\n\n\n\n<div class=\"wp-block-button\"><a class=\"wp-block-button__link has-primary-background-color has-background wp-element-button\" style=\"border-radius:0px\">Python<\/a><\/div>\n<\/div>\n<\/div>\n<\/div>\n\n\n\n<p><\/p>\n<\/div>\n","protected":false},"excerpt":{"rendered":"<p>Readability Expectations Programming languages have grammar rules just like human languages. Syntax rules are requirements &#8212; the code will not work unless you follow them. Style or &#8220;best practice&#8221; rules allow for good coding and consistent readability. In order to be a good programmer your code should have good readability! General Guidelines For any variables\/functions\/classes\/etc [&hellip;]<\/p>\n","protected":false},"author":1,"featured_media":0,"parent":0,"menu_order":0,"comment_status":"closed","ping_status":"closed","template":"","meta":{"footnotes":""},"class_list":["post-82","page","type-page","status-publish","hentry"],"jetpack_sharing_enabled":true,"_links":{"self":[{"href":"http:\/\/katzcs.com\/index.php?rest_route=\/wp\/v2\/pages\/82","targetHints":{"allow":["GET"]}}],"collection":[{"href":"http:\/\/katzcs.com\/index.php?rest_route=\/wp\/v2\/pages"}],"about":[{"href":"http:\/\/katzcs.com\/index.php?rest_route=\/wp\/v2\/types\/page"}],"author":[{"embeddable":true,"href":"http:\/\/katzcs.com\/index.php?rest_route=\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"http:\/\/katzcs.com\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=82"}],"version-history":[{"count":9,"href":"http:\/\/katzcs.com\/index.php?rest_route=\/wp\/v2\/pages\/82\/revisions"}],"predecessor-version":[{"id":110,"href":"http:\/\/katzcs.com\/index.php?rest_route=\/wp\/v2\/pages\/82\/revisions\/110"}],"wp:attachment":[{"href":"http:\/\/katzcs.com\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=82"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}