// Internet Duct Tape

Searching for the Perfect Inline Code Documentation Tool

Posted in Programming Tools, Ruby, Technology, Writing Better Documentation by engtech on March 07, 2008

Programming Tips

Even amongst programmers I’m weird because I have an intense love for documentation. No, that doesn’t mean I overly comment my code, or that you’ll catch me browsing happily through the product requirements document during my coffee break. I should be more specific.

engtech-documentation-unravelling.png

I have an intense love automatic documentation generation. Nothing makes me more tickled pink than seeing code and documentation living side by side in perfect harmony. I hate seeing documentation put on the company intranet only to diverge from the code it’s supposed to explain as the days go past. I hate hitting my head against a brick wall as I’m pouring through the source code trying to understand an API because at no point does it mention that it’s documented in a Word doc in another directory.

This is my rule of programming: documentation should live beside the code it documents, in the comments, especially if it’s API documentation. If your language of choice doesn’t already have some kind of automatic code generation tool then you’re probably using the wrong language.

(more…)

Delicious Links – 20 links – programming, community, development, twitter, lisp

Posted in Best of Feeds by engtech on February 09, 2008

Weekly Links

This is my weekly collection of the best stuff I saw on the Internet. They’re saved on delicious and stumbleupon and cross-posted to Twitter and Tumblr as they happen and then collected together for my blog on Internet Duct Tape.

Subscribe to Internet Duct Tape using RSS or using email.

This Week at Internet Duct Tape

Internet Duct Tape is my blog where I talk about software, technology, blogging and other geeky subjects.

Tags: , , , , , ,

Best of Feeds – 23 links – programming, music, photography, psychology, rails

Posted in Best of Feeds by engtech on January 13, 2008

RSS feeds are like cookies (that are good enough for me). Best of Feeds is a weekly collection of the best stuff I saw on the Internet this week. They’re saved on delicious and stumbleupon and cross-posted to Twitter and Tumblr as they happen and then collected together on Saturdays. I don’t blog on the weekend so read these links instead.Subscribe to //engtech to see this every week (or get it by email).

Legend

  • saves – number of people who bookmarked on http://del.icio.us
  • inbound links – number of blogs who linked to it (max 100)
  • diggs – number of people who dugg on http://digg.com

This Week at Internet Duct Tape

This Week at IDT Labs

  • [WORDPRESS] Category Resizer v1.0
    • WordPress Category Resizer 2008/01/02 – v1.0 – BUGFIX: newer versions of WordPress.com broke this script – BUGFIX: will run on any WordPress install, not just WordPress.com – BUGFIX: now works when you have less than three categories – added automatic update check – Tested with WordPress.com…
  • [WORDPRESS] Comment Ninja v0.5
    • Comment Ninja v0.5 2008/01/02 – 0.5 don’t display comment ninja in mass-edit mode, since it doesn’t work on that mode wordpress.com added avatars to the comment display and they were being sent in emails on multi-author blogs it grays out the comments you can’t edit IDT Labs is a…

Tags: , , , , , , ,

Best of Feeds – 30 links – programming, productivity, code, socialsoftware, socialnetworking

Posted in Best of Feeds by engtech on September 29, 2007

RSS feeds are like cookies (that are good enough for me). Best of Feeds is a weekly collection of the best stuff I saw on the Internet this week. They’re saved on delicious and stumbleupon and cross-posted to Twitter and Tumblr as they happen and then collected together on Saturdays. I don’t blog on the weekend so read these links instead.

Subscribe to //engtech to see this every week (or get it by email).

Legend

  • saves – number of people who bookmarked on http://del.icio.us
  • inbound links – number of blogs who linked to it (max 100)
  • diggs – number of people who dugg on http://digg.com

This Week at Internet Duct Tape

Tags: , , , , , , , , , , , , , , , , , ,

Follow

Get every new post delivered to your Inbox.

Join 281 other followers