{"id":536,"date":"2015-06-24T15:49:30","date_gmt":"2015-06-24T20:49:30","guid":{"rendered":"http:\/\/sunapi386.ca\/wordpress\/?p=536"},"modified":"2015-10-28T01:52:34","modified_gmt":"2015-10-28T06:52:34","slug":"types-of-code-commenting","status":"publish","type":"post","link":"https:\/\/sunapi386.ca\/wordpress\/types-of-code-commenting\/","title":{"rendered":"Types of code commenting"},"content":{"rendered":"<p>In the chapter on commenting, McConnell divides comments into six categories. Figure 3.1 gives summarized versions of his definitions, with some of his commentary.<\/p>\n<ul>\n<li>Repeat of the code: States what the code does in different words. Just more to read.<\/li>\n<li>Explanation of the code: Explains complicated, tricky, or sensitive code. Make the code clearer instead.<\/li>\n<li>Marker in the code: Identifies unfinished work. Not intended to be left in the completed code.<\/li>\n<li>Summary of the code: Distills a block of code into one or two sentences. Such comments are useful for quick scanning.<\/li>\n<li>Description of the code\u2019s intent: Explains the purpose of a section of code, more at the level of the problem than at the level of the solution.<\/li>\n<li>Information that cannot possibly be expressed by the code itself : Copyright notices, confidentiality notices, pointers to external documentation, etc.<\/li>\n<\/ul>\n","protected":false},"excerpt":{"rendered":"<p>In the chapter on commenting, McConnell divides comments into six categories. Figure 3.1 gives summarized versions of his definitions, with some of his commentary. Repeat of the code: States what the code does in different words. Just more to read. Explanation of the code: Explains complicated, tricky, or sensitive code. Make the code clearer instead. &hellip; <a href=\"https:\/\/sunapi386.ca\/wordpress\/types-of-code-commenting\/\" class=\"more-link\">Continue reading <span class=\"screen-reader-text\">Types of code commenting<\/span><\/a><\/p>\n","protected":false},"author":1,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"footnotes":""},"categories":[34],"tags":[],"class_list":["post-536","post","type-post","status-publish","format-standard","hentry","category-thoughts"],"_links":{"self":[{"href":"https:\/\/sunapi386.ca\/wordpress\/wp-json\/wp\/v2\/posts\/536","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/sunapi386.ca\/wordpress\/wp-json\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/sunapi386.ca\/wordpress\/wp-json\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/sunapi386.ca\/wordpress\/wp-json\/wp\/v2\/users\/1"}],"replies":[{"embeddable":true,"href":"https:\/\/sunapi386.ca\/wordpress\/wp-json\/wp\/v2\/comments?post=536"}],"version-history":[{"count":2,"href":"https:\/\/sunapi386.ca\/wordpress\/wp-json\/wp\/v2\/posts\/536\/revisions"}],"predecessor-version":[{"id":538,"href":"https:\/\/sunapi386.ca\/wordpress\/wp-json\/wp\/v2\/posts\/536\/revisions\/538"}],"wp:attachment":[{"href":"https:\/\/sunapi386.ca\/wordpress\/wp-json\/wp\/v2\/media?parent=536"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/sunapi386.ca\/wordpress\/wp-json\/wp\/v2\/categories?post=536"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/sunapi386.ca\/wordpress\/wp-json\/wp\/v2\/tags?post=536"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}