| Programming | Software Engineering | Web Design | Database | Operating Systems

CodeAsDocumentation

Sam Gentile
Keywords: Code,Documentation
From: http://samgentile.com/blog/archive/2005/05/31/12643.aspx

When I was on Ward's Wiki in 1996-2000 (something Ward personally thanked me for Thursday as he took me out to lunch) and we were coming up with would become XP, this was one of my huge hangups that took me a while to get right. As Martin says β€œAlmost immediately I feel the need to rebut a common misunderstanding. Such a principle is not saying that code is the only documentation. Although I've often heard this said of Extreme Programming - I've never heard the leaders of the Extreme Programming movement say this. Usually there is a need for further documentation to act as a supplement to the code.”  Misconception #1.

Then, β€œThe rationale for the code being the primary source of documentation is that it is the only one that is sufficiently detailed and precise to act in that role - a point made so eloquently by Jack Reeves's famous essay "What is Design?" This principle comes with a important consequence - that it's important that programmers put in the effort to make sure that this code is clear and readable.” So that's the thing. This practice ONLY makes sense in the context of other XP practices Refactor Mercilessly and Unit Tests. The only way the CodeAsDocumentation works is if you keep your code clean and concise so it is easier to understand, modify, and extend. Make sure everything is expressed once and only once. Then constantly test to make sure you didn't break anything. This keeps you code clean, readable and nimble.


Related Article
  • Simple Indigo Server (Code-based)
  • Simple Indigo Client (Code-based)
  • IIS5 and IIS6 Coding Differences(Include)
  • Use your own script to check your google adsense account
  • use you own php code access you google adsense account

  • Comment
    Bill Post At: 2007-1-6 12:19:54
    Hello, nice site look this:
    http://fastppc.info http://fastppc.info http://fastppc.info http://fastppc.info http://fastppc.info http://fastppc.info http://fastppc.info
    End ^) See you
    fake rolex Post At: 2007-5-2 20:56:39
    http://software.sci.utah.edu/bugzilla/showattachment.cgi?attach_id=204 fake rolex
    http://software.sci.utah.edu/bugzilla/showattachment.cgi?attach_id=205 rolex replica
    Yearby Post At: 2007-6-15 13:35:53
    hi all, nice site
    http://nokiaringtonesworld.info/free-nokia-ringtones/free-nokia-30302302330-ringtone-download.php http://nokiaringtonesworld.info/free-nokia-ringtones/ringtones-free-nokia-6016i-text-sprint-phone.php http://nokiaringtonesworld.info/free-nokia-ringtones/compose-free-nokia-ringtones.php http://nokiaringtonesworld.info/free-nokia-ringtones/download-free-nokia-3510i-polyphonic-ringtones.php http://nokiaringtonesworld.info/free-nokia-ringtones/free-nokia-ringtones-polyphonic.php http://nokiaringtonesworld.info/free-nokia-ringtones/free-nokia-3560-polyphonic-us-ringtones.php http://nokiaringtonesworld.info/free-nokia-ringtones/free-cell-phone-nokia-3560-ringtones.php http://nokiaringtonesworld.info/free-nokia-ringtones/ringtones-for-nokia-phones.php http://nokiaringtonesworld.info/free-nokia-ringtones/free-cellular-one-nokia-6101-real-ringtones.php http://nokiaringtonesworld.info/free-nokia-ringtones/free-nokia-1221-ringtones.php http://nokiaringtonesworld.info/free-nokia-ringtones/free-nokia-1100-ringtones.php http://nokiaringtonesworld.info/free-nokia-ringtones/nokia-cell-phone-ringtones.php http://nokiaringtonesworld.info/free-nokia-ringtones/mobile-phone-monophonic-ringtones-nokia-composer.php
    greenwoodz Post At: 2007-6-25 21:30:27
    [url= http://thk2.info/Sunlightfinancial.html ]Sunlightfinancial[/url]
    greenwoodz Post At: 2007-6-26 0:17:44
    [url= http://thk2.info/Bilara.html ]Bilara[/url]
    greenwoodz Post At: 2007-6-26 3:03:19
    [url= http://thk2.info/Jcpenneys.html ]Jcpenneys[/url]
    greenwoodz Post At: 2007-6-26 5:42:50
    [url= http://thk2.info/Frenchcum.com.html ]Frenchcum.com[/url]
    vsqcimxoux Post At: 2007-8-16 14:48:40
    Hello! Good Site! Thanks you! defhdthcpzbfg
    gmaingogo Post At: 2008-4-15 6:31:08
    http://forge.mysql.com/people/person.php?id=1195 phentermine
    Vfrdayci Post At: 2008-7-10 6:03:35
    test speed
    profile3rrqewr Post At: 2008-7-25 4:59:57
    http://www.imdb.com/user/ur19659916/boards/profile/ phentermine
    Add Your Comment:
    Your Name:      
    Your Comment:
    Note: After you post comment,please refresh the browser to show you comment.
    Search In YeYan.CN:
     

    Home | Privacy Policy | Copyright Policy | Contact Us | Site Map
    Copyright © 2006 YeYan.CN, All Rights Reserved.