« video demo of kfm selections
kfm 0.4 - multilingual »
18 07 2006

commented blocks of code

Posted by: Kae Verens, in javascript, php

I was reading an article about maintainable JavaScript, and thought I’d comment on it about a method I use to keep my own JavaScript clean.

Although this is about JavaScript, the exact same trick works in PHP as well.

A method I use for commenting also helps me to create navigable code. I use vim for coding, which allows me to “fold” at the ‘{’ mark, making blocks and functions into hierarchical trees.

A useful thing about this, is that you can then place your comment after the ‘{’.

screenshot.png

For example, check out this code.

Scattered throughout the code, you can find blocks starting with “{ //“.

A handy thing about the {..} syntax, is that it doesn’t actually need to follow an if/function()/for() qualifier! This means that you can logically separate your code into blocks of contextually similar code.

kdevelop and other IDEs also allow you to fold at the’{’ mark.

This entry was posted on Tuesday, July 18th, 2006 at 8:57 am and is filed under javascript, php. You can follow any responses to this entry through the RSS 2.0 feed. Responses are currently closed, but you can trackback from your own site.

2 Responses to “commented blocks of code”

  1. Chris Heilmann says:
    July 18th, 2006 at 9:02 am

    That is quite a neat way of commenting - for windows users, UltraEdit does the same thing.

  2. Kae Verens says:
    July 18th, 2006 at 10:30 am

    thanks Chris.

    Notice that in the linked example, all switch() blocks also use the trick. It’s not only for comments ;-)