24
Apr
10

Some common methods for indicating important comments are TODO, BUG, KLUDGE and TRICKY. You can try this in any language, I’m using this in Action Script, PHP, Flex and Javascript and CSS also :P .

1 . // :TODO: Description
Indicates that there is more to do here.
2. // :BUG: [bugid] Description
Shows a known issue here. The comment should also explain the issue and optionally give a bug ID if applicable.
3. // :KLUDGE: Description
Indicates that the following code is not elegant or does not conform to best practices. This comment alerts others to provide suggestions about how to code it differently next time.
4. // :TRICKY: Description
Notifies developers that the subsequent code has a lot of interactions. Also advises developers that they should think twice before trying to modify it.

  • del.icio.us
  • Digg
  • Facebook
  • LinkedIn
  • Google Bookmarks
  • Twitter
  • MySpace
  • Mixx
  • Reddit
  • DZone
  • Sphinn
  • StumbleUpon
  • Blogplay
  • Diigo
  • Live
  • MSN Reporter
  • Technorati
  • NewsVine
  • Yahoo! Bookmarks
  • Netvibes
  • Design Float
  • Add to favorites
  • email
  • Yahoo! Buzz
  • Gwar
  • FriendFeed
  • Tumblr
  • Print
  • PDF
  • RSS

About Midhun Devasia

I'm a 26 year old Web Developer from Cochin, India.I had completed my B.Tech Computer Science and Engineering from SNGCE, Cochin. Now am working as a Technical Manager for a Web Development company at Cochin, India . I have 1 year experience in Java and 3 year experience in Web Technologies.
This entry was posted in Flash, General, Javascript, PHP, Programming and tagged , , , , , , , , . Bookmark the permalink.

Leave a Reply

Your email address will not be published. Required fields are marked *

*

You may use these HTML tags and attributes: <a href="" title=""> <abbr title=""> <acronym title=""> <b> <blockquote cite=""> <cite> <code> <del datetime=""> <em> <i> <q cite=""> <strike> <strong>