{"id":2904,"date":"2010-09-24T11:22:09","date_gmt":"2010-09-24T10:22:09","guid":{"rendered":"http:\/\/www.walkingrandomly.com\/?p=2904"},"modified":"2010-09-24T11:22:09","modified_gmt":"2010-09-24T10:22:09","slug":"best-source-code-comment-ever","status":"publish","type":"post","link":"https:\/\/walkingrandomly.com\/?p=2904","title":{"rendered":"Best source code comment ever?"},"content":{"rendered":"<p>One of my friends on facebook posted the following source code comment which I am sorely tempted to use in some future projects.<\/p>\n<pre>\/\/\r\n\/\/ Dear maintainer:\r\n\/\/\r\n\/\/ Once you are done trying to 'optimize' this routine,\r\n\/\/ and have realized what a terrible mistake that was,\r\n\/\/ please increment the following counter as a warning\r\n\/\/ to the next guy:\r\n\/\/\r\n\/\/ total_hours_wasted_here = 32\r\n\/\/\r\n<\/pre>\n<p>It turns out that this is one of many examples in a superb thread on <a href=\"http:\/\/stackoverflow.com\/questions\/184618\/what-is-the-best-comment-in-source-code-you-have-ever-encountered\">StackOverflow.com<\/a><\/p>\n","protected":false},"excerpt":{"rendered":"<p>One of my friends on facebook posted the following source code comment which I am sorely tempted to use in some future projects. \/\/ \/\/ Dear maintainer: \/\/ \/\/ Once you are done trying to &#8216;optimize&#8217; this routine, \/\/ and have realized what a terrible mistake that was, \/\/ please increment the following counter as [&hellip;]<\/p>\n","protected":false},"author":3,"featured_media":0,"comment_status":"open","ping_status":"open","sticky":false,"template":"","format":"standard","meta":{"jetpack_post_was_ever_published":false,"footnotes":"","jetpack_publicize_message":"","jetpack_publicize_feature_enabled":true,"jetpack_social_post_already_shared":false,"jetpack_social_options":{"image_generator_settings":{"template":"highway","default_image_id":0,"font":"","enabled":false},"version":2}},"categories":[45,7],"tags":[],"class_list":["post-2904","post","type-post","status-publish","format-standard","hentry","category-just-for-fun","category-programming"],"jetpack_publicize_connections":[],"jetpack_featured_media_url":"","jetpack_shortlink":"https:\/\/wp.me\/p3swhs-KQ","jetpack_sharing_enabled":true,"_links":{"self":[{"href":"https:\/\/walkingrandomly.com\/index.php?rest_route=\/wp\/v2\/posts\/2904","targetHints":{"allow":["GET"]}}],"collection":[{"href":"https:\/\/walkingrandomly.com\/index.php?rest_route=\/wp\/v2\/posts"}],"about":[{"href":"https:\/\/walkingrandomly.com\/index.php?rest_route=\/wp\/v2\/types\/post"}],"author":[{"embeddable":true,"href":"https:\/\/walkingrandomly.com\/index.php?rest_route=\/wp\/v2\/users\/3"}],"replies":[{"embeddable":true,"href":"https:\/\/walkingrandomly.com\/index.php?rest_route=%2Fwp%2Fv2%2Fcomments&post=2904"}],"version-history":[{"count":2,"href":"https:\/\/walkingrandomly.com\/index.php?rest_route=\/wp\/v2\/posts\/2904\/revisions"}],"predecessor-version":[{"id":2906,"href":"https:\/\/walkingrandomly.com\/index.php?rest_route=\/wp\/v2\/posts\/2904\/revisions\/2906"}],"wp:attachment":[{"href":"https:\/\/walkingrandomly.com\/index.php?rest_route=%2Fwp%2Fv2%2Fmedia&parent=2904"}],"wp:term":[{"taxonomy":"category","embeddable":true,"href":"https:\/\/walkingrandomly.com\/index.php?rest_route=%2Fwp%2Fv2%2Fcategories&post=2904"},{"taxonomy":"post_tag","embeddable":true,"href":"https:\/\/walkingrandomly.com\/index.php?rest_route=%2Fwp%2Fv2%2Ftags&post=2904"}],"curies":[{"name":"wp","href":"https:\/\/api.w.org\/{rel}","templated":true}]}}