DenkzeitWiki

Maintainable Code

• Wiki:SelfDocumentingCode
• Wiki:DocumentationBeyondTheSourceCode
• Wiki:LightweightDocumentation
  
• http://acmqueue.com/modules.php?name=Content&pa=showpage&pid=290&page=2 --Comments are More Important than Code
  • http://developers.slashdot.org/article.pl?sid=05/04/26/2355242
  
  
• http://vafer.org/blog/tcurdt/archives/000183.html --Why JavaDocs suck
  
• http://www.voidspace.org.uk/python/weblog/arch_d7_2005_05_28.shtml#e54 --Document Driven Design
  
• http://www.joelonsoftware.com/articles/Wrong.html --Making Wrong Code Look Wrong, JoelSpolsky introducing the HungarianNotation Exceptions
  • http://beust.com/weblog/archives/000282.html --We are all Hungarian Notation users. Yes, even you!
    
  
  
• How To Write Unmaintainable Code
  • QuotesFromUnmaintainableCode
  
  
• The Noble Art of Maintenance Programming
  • The status quo is all wrong. Maintenance is a significant intellectual challenge as well as a solution and not a problem. If we want to maximize our effectiveness at doing it, we need to significantly change the way in which we assign people to it.
  • Andy Hunt: It's only the first 10 minutes that the code's original, when you type it in the first time. That's it.
  • We're programmers. Programmers are, in their hearts, architects, and the first thing they want to do when they get to a site is to bulldoze the place flat and build something grand. We're not excited by incremental renovation: tinkering, improving, planting flower beds.
  
  
• Cyclomatic complexity for python code
  • Complexity - measuring the complexity of python-scripts
    
  
  
• http://www.gamasutra.com/view/feature/4111/dirty_coding_tricks.php via
  • patching because of fear to change code - to improve the code - fearing to rewrite
    • ~> the road to hell is patched with patches
  • tests, anyone?