We’ve written before about the value of writing your README before your code, but what about when it comes to the actual code? Terse one-liners? Paragraph-long descriptions? How much is enough and when is it too much?
How to comment code is a perennial subject of debate for programmers, one that developer Zachary Voase recently jumped into, arguing that one of the potential flaws with extensive comments (or any comments really) is that they never seem to get updated when the code changes. “We forget,” writes Voase, “overlooking a comment when changing the fundamental behavior of semantics of the code to which it relates.”
Voase thinks the solution is in our text editors, which typically “gray out” comments, fading then into the background so we can focus on the actual code. We ought to do the opposite, he believes: Make the comments jump out. Looking at the visual examples on Voase’s post makes the argument a bit more compelling. Good text editors have configurable color schemes so it shouldn’t be too hard to give this a try and see if it improves your comments and your code.
Another approach is to treat comments as a narrative. Dave Winer recently mentioned comments in passing, writing about the benefits of using an outliner to handle comments since it makes it easy to show and hide them:
MORE: The Best Way to Comment Your Code | Webmonkey | Wired.com.
Pingback: metoclopramide 10 mg online pharmacymetoclopramide price()
Pingback: metoprolol 100mg united kingdom()
Pingback: gemfibrozil no prescription()
Pingback: digoxin purchase()
Pingback: terbinafine 250mg online()
Pingback: lamotrigine 25mg for sale()
Pingback: propranolol 80mg without a prescription()
Pingback: azathioprine canada()
Pingback: sumatriptan 50mg medication()
Pingback: isosorbide for sale()
Pingback: glipizide 5 mg without a prescription()
Pingback: order nitrofurantoin()
Pingback: alendronate coupon()
Pingback: tamsulosin 0.4mg over the counter()
Pingback: etodolac cheap()
Pingback: estradiol 1mg tablet()
Pingback: cheap erythromycin()
Pingback: where can i buy amitriptyline 50 mg()
Pingback: venlafaxine 75mg canada()
Pingback: bisacodyl 5 mg without a doctor prescription()
Pingback: where to buy doxycycline()
Pingback: oxybutynin 2.5 mg pharmacy()
Pingback: phenytoin united states()
Pingback: buy fluconazole 200mg()
Pingback: acetazolamide pills()
Pingback: tolterodine pills()
Pingback: trazodone price()
Pingback: where can i buy divalproex 250mg()
Pingback: desmopressin mcg without a doctor prescription()
Pingback: order rosuvastatin 5 mg()
Pingback: warfarin coupon()
Pingback: carvedilol 12.5 mg for sale()
Pingback: order prochlorperazine 5mg()
Pingback: where can i buy clindamycin 300 mg()
Pingback: where to buy loratadine()
Pingback: ciprofloxacin united states()
Pingback: cephalexin price()
Pingback: citalopram purchase()
Pingback: celecoxib 100 mg australia()
Pingback: cefuroxime purchase()
Pingback: clonidinemg over the counter()
Pingback: how to purchase buspirone 10 mg()
Pingback: where to buy olmesartan 20 mg()
Pingback: how to buy dutasteride()
Pingback: irbesartan usa()
Pingback: anastrozole 1 mg online pharmacy()
Pingback: order donepezil 5 mg()
Pingback: atomoxetine pills()
Pingback: leflunomide canada()
Pingback: meclizine 25 mg united states()
Pingback: where can i buy glimepiride()
Pingback: how to purchase fexofenadine()
Pingback: spironolactone 100mg uk()
Pingback: pioglitazone 15 mg without a doctor prescription()
Pingback: aripiprazole 15 mg usa()
Pingback: escitalopram pharmacy()
Pingback: furosemide 40 mg online()
Pingback: tadalafil coupon()
Pingback: sildenafil pills()
Pingback: zyvox nz()
Pingback: how to buy zyprexa()
Pingback: zyloprim 100 mg cost()
Pingback: zovirax generic()
Pingback: zocor medication()
Pingback: more info here()
Pingback: zithromax without a doctor prescription()
Pingback: zanaflex 2 mg prices()
Pingback: wellbutrin 300 mg tablets()
Pingback: voltaren 50 mg online()
Pingback: verapamil 40 mg usa()
Pingback: valtrex 500 mg online pharmacy()
Pingback: tricor 160 mg online()
Pingback: toprol 50 mg united kingdom()
Pingback: thorazine 100 mg online()
Pingback: tenormin 100 mg no prescription()
Pingback: spiriva 9mcg purchase()
Pingback: skelaxin 400mg online pharmacy()
Pingback: singulair 10mg online()
Pingback: seroquel for sale()
Pingback: rogaine nz()
Pingback: robaxin no prescription()
Pingback: how to buy risperdal 2mg()
Pingback: revatio 20 mg medication()
Pingback: retin-a cream price()
Pingback: remeron otc()
Pingback: reglan australia()
Pingback: pyridium tablets()
Pingback: pulmicort 200 mcg cheap()
Pingback: provigil cost()
Pingback: protonix 40mg coupon()
Pingback: cheap proscar()
Pingback: procardia 30 mg united states()
Pingback: cheapest proair inhaler 100 mcg()
Pingback: cost of prilosec()
Pingback: cheapest prevacid 15mg()
Pingback: prednisolone 20 mg united states()
Pingback: phenergan 25 mg purchase()
Pingback: periactin 4 mg cheap()
Pingback: nortriptyline for sale()
Pingback: motrin no prescription()
Pingback: how to purchase mobic 15 mg()
Pingback: meclizine 25mg tablets()
Pingback: macrobid medication()
Pingback: luvox 100mg australia()
Pingback: lopressor pharmacy()
Pingback: lopid tablets()
Pingback: how to purchase levaquin()
Pingback: lamisil otc()
Pingback: imuran 50 mg without a doctor prescription()
Pingback: he said()
Pingback: imodium 2mg united states()
Pingback: imitrex 100 mg purchase()
Pingback: imdur pharmacy()
Pingback: hyzaar medication()
Pingback: geodon online pharmacy()
Pingback: cheapest garcinia cambogia 100caps()
Pingback: flomax tablet()
Pingback: etodolac cost()
Pingback: erythromycin usa()
Pingback: elavil 25mg price()
Pingback: dramamine for sale()
Pingback: doxycycline online pharmacy()
Pingback: diltiazem 120mg online()
Pingback: differin for sale()
Pingback: diamox 250mg without a prescription()
Pingback: depakote uk()
Pingback: ddavp 0.1mg united states()
Pingback: dapsone caps online pharmacy()
Pingback: cymbalta for sale()
Pingback: how to buy crestor 5 mg()
Pingback: cozaar pills()
Pingback: coumadin 1mg united states()
Pingback: compazine cost()
Pingback: how to purchase coreg()
Pingback: combivent without a prescription()
Pingback: cheap symbicort inhaler()
Pingback: colchicine without a doctor prescription()
Pingback: clozaril 25mg for sale()
Pingback: clonidine tablets()
Pingback: clomid coupon()
Pingback: cleocin 300 mg prices()
Pingback: how to write an intro for an essay()
Pingback: essays()
Pingback: assignments help()
Pingback: buy papers online()
Pingback: pay to write essays()
Pingback: algebra homework answers()
Pingback: admission essay writing service()
Pingback: admission essay writing service()
Pingback: essay help()
Pingback: Real viagra online()
Pingback: buy essays online cheap()
Pingback: cbd oil benefits and uses in books()
Pingback: cbd hemp oil drops for pain for sale()
Pingback: cbd massage oil()
Pingback: vg cbd oil()
Pingback: hemp oil vs cbd oil for pain()
Pingback: personal loans lincoln ne()
Pingback: unsecured payday loans()
Pingback: bad credit loans with no credit check()
Pingback: quick loans mn()
Pingback: installment loans online for bad credit()
Pingback: payday loans loans online()
Pingback: payday loan help()
Pingback: personal loans company()
Pingback: cheap liability car insurance quotes()
Pingback: car insurance quotes renewal()
Pingback: aaa car insurance()
Pingback: affordable insurance()
Pingback: best car insurance()
Pingback: car insurance usaa()
Pingback: liberty car insurance quotes()
Pingback: access car insurance()
Pingback: best car insurance()
Pingback: liberty car insurance quotes()
Pingback: online slots real money()
Pingback: online casino usa real money()
Pingback: casino()
Pingback: real online casino()
Pingback: online casino usa real money()
Pingback: casino online gambling()
Pingback: online gambling()
Pingback: live casino slots online()
Pingback: slot machine()
Pingback: san manuel casino online()
Pingback: claritin coupon()
Pingback: cipro canada()
Pingback: buy cephalexin 500 mg()
Pingback: celexa no prescription()
Pingback: order celebrex 200 mg()
Pingback: cheapest ceftin 125 mg()
Pingback: ceclor nz()
Pingback: catapres 100mcg united kingdom()
Pingback: casodex online()
Pingback: sildenafil 50mg without a prescription()
Pingback: cheapest Cialis 40 mg()
Pingback: how to purchase Cialis 10mg()
Pingback: where can i buy Viagra 50mg()
Pingback: buy Viagra 25 mg()
Pingback: Viagra 50mg tablet()
Pingback: Viagra 100 mg pills()
Pingback: cheap cialis online()
Pingback: droga5.net()
Pingback: purchasing cialis online()
Pingback: viagra samples()
Pingback: viagra online pharmacy()
Pingback: viagra online canada()
Pingback: casino real money()
Pingback: real money casino online()
Pingback: real money casino()
Pingback: cialis 20()
Pingback: play casino tycoon online()
Pingback: generic cialis()
Pingback: generic cialis()
Pingback: chewable viagra 100mg()
Pingback: cialis 20()
Pingback: online casinos for usa players()
Pingback: buy viagra overnight delivery()
Pingback: viagra prescription()
Pingback: cash advance()
Pingback: quick cash loans()
Pingback: no credit check loans()
Pingback: what would happen if a girl took cialis()
Pingback: careprost eyelash growth amazon()
Pingback: cheapest 100 viagra uk()
Pingback: casino slots gambling()
Pingback: real money casino games()
Pingback: viagra prices()
Pingback: online casino with free signup bonus real money usa()
Pingback: golden nugget online casino()
Pingback: cialis otc()
Pingback: vardenafil generic()
Pingback: vardenafil pills()
Pingback: cialis mastercard()
Pingback: walmart pharmacy()
Pingback: cialis online()
Pingback: buying ed pills online()
Pingback: generic ed pills()
Pingback: best ed medication()
Pingback: viagra generic()
Pingback: online pharmacy viagra()
Pingback: viagra 50mg()
Pingback: can i buy chloroquine over the counter()
Pingback: viagra and alcohol()
Pingback: tylenol order()
Pingback: otc cialis()
Pingback: hydroxychloroquine virus()
Pingback: careprost wholesale outside usa()
Pingback: levitra vs cialis()
Pingback: cialis professional()
Pingback: is there a generic cialis available?()
Pingback: buy naltrexone online usa()
Pingback: viagra without a doctor prescription()
Pingback: Overnight viagra()
Pingback: india generic viagra lowest price()
Pingback: albuterol inhaler for sale generic()
Pingback: Buy pfizer viagra()
Pingback: cialis 20()
Pingback: cialis online()
Pingback: cialis coupon cvs()
Pingback: OS bot()
Pingback: website()
Pingback: cna night classes()
Pingback: aquabody()
Pingback: fitness mayol()
Pingback: buy anadrol online()
Pingback: купить комод()
Pingback: comprar esteroides()
Pingback: search all craigslist()
Pingback: buy zopiclone online()
Pingback: oxigenare hiperbara contraindicatii augmentin()
Pingback: gmail log in()
Pingback: Greg Thmomson()
Pingback: Stephani Mitchel()
Pingback: anivar()
Pingback: oxy oxymetholone()
Pingback: should i use propecia()
Pingback: linhchitp.com Nấm linh chi()
Pingback: Buy Drugs Without a Prescription()
Pingback: poker online()
Pingback: texas holdem poker free game()
Pingback: texas holdem poker online()
Pingback: judi online()
Pingback: Ruth Watkins()
Pingback: John Harper()
Pingback: Live draw hongkong()
Pingback: London removals()
Pingback: step by step golf swing pictures()
Pingback: handmade sofa essex()
Pingback: https://tribot.org/#free 07scape runescape bot 2016 tribot()
Pingback: satta matka()
Pingback: game subway()
Pingback: steroids in south africa()
Pingback: DIA taxis()
Pingback: Facebook Live()
Pingback: Term Life Insurance()
Pingback: top 10 steroid sites()
Pingback: lawyerforaccident.net()
Pingback: opulence for life review()
Pingback: angara fahise()
Pingback: angara fahise()
Pingback: Best in the World()
Pingback: legit steroids for sale()
Pingback: maquillage avril()
Pingback: www.recycletotes.com()
Pingback: artisan electricien epinay sur seine()
Pingback: clemsondeckbuilders.com/()
Pingback: buy steroids online legit()
Pingback: roids for sale()
Pingback: bad signage caused an accident()
Pingback: 2007scape bot farm https://tribot.org/()
Pingback: visit site()
Pingback: Hausstaubmilbenallergie()
Pingback: garcinia cambogia()
Pingback: economics tutor()
Pingback: economics tutor()
Pingback: scrap car recycle()
Pingback: buying steroids online legal()
Pingback: buy backlinks()
Pingback: cocuk sex escort()
Pingback: helpful site()
Pingback: reserver hotel pas cher()