by EL1 2 on July 23rd, 2007

EL1 2

Question

Help answer this question below.

Is there anything more painful than documenting code?

  • Like
  • Report

Answers. 24 helpful answers below.

  • by HungryGuy on February 17th, 2008

    HungryGuy

    Yes: debugging undocumented code.

    • Like
    • Report

    2 comments | Post one | Permalink

  • by Ghost Rider on December 30th, 2007

    Ghost Rider

    Yes: Documenting someone else's code

    • Like
    • Report

    1 comment | Post one | Permalink

  • by PrettyPirate on July 23rd, 2007

    PrettyPirate

    Natural childbirth.

    • Like
    • Report

    4 comments | Post one | Permalink

  • by Frank Tank on July 23rd, 2007

    Frank Tank

    No, but undocumented code means I have the privy to rewrite it at my will.

    • Like
    • Report

    No comments. Post one | Permalink

  • by Jodie44 on July 23rd, 2007

    Jodie44

    Any longer than five seconds in stiletto heels.

    • Like
    • Report

    1 comment | Post one | Permalink

  • by zee-ster on July 23rd, 2007

    zee-ster

    yeah, having to rewrite a program with no documentation in or outside the code!! oh, and the variable names aren't helpful either. arg.

    • Like
    • Report

    1 comment | Post one | Permalink

  • by Derek DuCote on February 17th, 2008

    Derek DuCote

    Having a dislocated limb relocated. Fortunately I've never had to go through that, but remembering the screams of patients I have seen whilst having that done, haunts me.

    • Like
    • Report

    2 comments | Post one | Permalink

  • by nunya on December 18th, 2007

    nunya

    Yes - working with code that is not documented.

    • Like
    • Report

    No comments. Post one | Permalink

  • by JimmyG on September 12th, 2008

    JimmyG

    Painful because they're two different disciplines. Most people are uncomfortable outside their own discipline.

    Programmers' documentation, when they bother, often sounds like code:

    //Multiply interest times principal
    yield = interest * principal;

    • Like
    • Report

    No comments. Post one | Permalink

  • by Mushen on April 29th, 2008

    Mushen

    Only one thing and that is being the unlucky sod who has to write the Help file for the damn application.

    • Like
    • Report

    No comments. Post one | Permalink

  • by just helping on April 29th, 2008

    just helping

    Yes! tweaking code in HTML or a website design to get the right look.

    • Like
    • Report

    No comments. Post one | Permalink

  • by Takei-Shihan on December 18th, 2007

    Takei-Shihan

    Certain pressure point pinches ... but just barely ...

    I have had the pain of rewriting the interface for a "robotic spindler" that wraps wire to make electric motors, transformers, and electromagnets. It was written in Assembler to run on a Unix mainframe with absolutely no documentation, and the interface that existed was in Mandarin Chinese (my fifth language) and I had to find and fix the "it won't run" bugs, and then both translate the whole thing into a bilingual French/English interface and also write full documentation for exactly what every line of code is for.

    • Like
    • Report

    No comments. Post one | Permalink

  • by TofuBug on February 27th, 2009

    TofuBug

    Wow I'm actually surprised no one has even mentioned it.

    Ever had a code review with someone who knows nothing about programing yet constantly asks really stupid unrelated questions just to make themselves sound smart.

    That or trying to explain to a head strong executive that no programing language is a "magic wand" and that their "brilliant idea" just isn't feasible for one technical reason or another.

    I spend more time at the office in meetings about pointless stuff than I do actually developing software.

    Compared to that I actually look forward to documenting my code.

    No comments. Post one | Permalink

  • by JakobA I^_^I the alooney on January 6th, 2009

    JakobA I^_^I the alooney

    Yes. Answering the production depts questions about the code you wrote (and did not document) 5 years ago.

    No comments. Post one | Permalink

  • by JJeffrey on February 17th, 2008

    JJeffrey

    YES!! NOT documenting code and then have the next programmer try to figure out what the IDIOT before him was doing!!! Documentation is part of programming!!!

    No comments. Post one | Permalink

  • by Lilibuth12 on February 16th, 2008

    Lilibuth12

    sliding down a rusty razor blade!!! lol!

    No comments. Post one | Permalink

  • by Shawnothius on December 16th, 2007

    Shawnothius

    documenting code isnt hard, just give a brief description of what is happening, and trust me you want documents when you need to find an error in 30 pages of code.

    No comments. Post one | Permalink

  • by rdrainer on July 23rd, 2007

    rdrainer

    1) Running it through SDLC.
    2) Rekeying it after the source member is lost.
    3) Producing a Test Case document when the Baseline cases aren't mirrored in the Parallel runs.
    4) Removing the debugging code you worked so hard to put into it because the shop standard requires no debugging code when a module is promoted.
    5) Being one of a dozen programmers working on the same piece of code at the same time.
    ... about a few other things in the same vein ...
    but that's enough for now.

    No comments. Post one | Permalink

  • by bigbore on February 17th, 2008

    bigbore

    getting stabbed or shot, ive been through all 3 and id choose Documenting code any day of the week.

    No comments. Post one | Permalink

  • by Borderlinux on February 17th, 2008

    Borderlinux

    documenting disassembled code

    No comments. Post one | Permalink

  • by patio4it (tumblr) on November 16th, 2008

    patio4it (tumblr)

    Understanding the documentation if it's written in a language you never learned.

    No comments. Post one | Permalink

  • by suMit on February 26th, 2008

    suMit

    to understand flow of program using someone else code that is not documented.

    No comments. Post one | Permalink

  • by web 2.0 on February 22nd, 2008

    web 2.0

    of course, that is nothing to do at all..

    if you're doing coding for a living, then you shud really b feeling luck to have codes to write,

    and happy as well, if you think you're in the wrong field, i think you shud quit, and do what you're happy at

    No comments. Post one | Permalink

  • by iortizvictory on February 7th, 2009

    iortizvictory

    Hey check out the open source tool NDoc http://ndoc.sourceforge.net/ . This tool will assist in writting your documentation based on the comments that you input.

Want to attach an image to your answer? Click here.

Did this answer your question? If not, then ask a new question or create a poll.

You're reading Is there anything more painful than documenting code?

Follow us on Facebook!

Related Ads

ANSWERBAG BUZZ

Documenting code painful