https://skysigal.com/ 2026-04-18T13:00:31+00:00 https://skysigal.com/ https://skysigal.com/lib/tpl/bootstrap3/images/favicon.ico text/html 2023-11-04T22:54:52+00:00 Anonymous (anonymous@undisclosed.example.com) https://skysigal.com/it/ad/code_comments/examples/blocked_out_legacy_code?rev=1699138492&do=diff IT:AD:Code Comments:Examples:Blocked out Legacy Code * (UP) We've all seen huge chunks of legacy code blocked out as comments...“cause it might be needed again in the future”. Notes * If it was being changed, it's because whatever was there in the first place wasn't doing what was needed. text/html 2023-11-04T22:54:52+00:00 Anonymous (anonymous@undisclosed.example.com) https://skysigal.com/it/ad/code_comments/examples/captain_obvious?rev=1699138492&do=diff IT:AD:Code Comments:Examples:Captain Obvious * (UP) At least it's correct... Example Don't state the obvious. To be fair, in earlier languages it might have been slightly more relevant: text/html 2023-11-04T03:39:10+00:00 Anonymous (anonymous@undisclosed.example.com) https://skysigal.com/it/ad/code_comments/examples/home?rev=1699069150&do=diff IT:AD:Code Comments:Examples * (UP) examples index Summary Listed above are some examples of what not to do. text/html 2023-11-04T22:54:53+00:00 Anonymous (anonymous@undisclosed.example.com) https://skysigal.com/it/ad/code_comments/examples/not_an_excuse_for_convoluted_code?rev=1699138493&do=diff IT:AD:Code Comments:Examples:Not an Excuse for Convoluted Code * (UP) Summary The primary argument of code purists for not commenting code is that code should be self-explanatory. It is important to note that this is a argument from the point of developers text/html 2023-11-04T22:54:55+00:00 Anonymous (anonymous@undisclosed.example.com) https://skysigal.com/it/ad/code_comments/examples/novels?rev=1699138495&do=diff IT:AD:Code Comments:Examples:Novels * (UP) Writing code is an expensive process. Add in the reality of staff rotation, and the argument for documentation right where the developer is working (rather than an external system) is validated. But there's a point where it goes to far.