Skip to main content

Comment your code ...

Comment your code ...

For any programmers, it is always strongly recommended to have explicit comments to strategic sections of the code. Commenting a code is very important for many reasons:

  1. It would serve as a valuable memory into what the particular code does. You may not know that down the line, after five years, when you see the code without comments, the same code might sound greek and latin.
  2. A good commented code can easily enable a peer developer to start maintaining it without bothering you for pesky queries on the same.
  3. Where possible, try using summary commenting like in JavaDoc and C# Xml commenting features.

When not to comment?

  1. If you are replacing a logic with another logic, do not comment the older logic and append the new one, as far as possible. That would only serve to increase the file size and complicate the maintainability of the code. To maintain history, use a good Source Control rather.
  2. Avoid explicit and greater detail comments in clientside scripting code like JavaScript which only increases a great pagesize.

Comments

Popular posts from this blog

Google NCR

Google NCRMost of you would be knowing about this trick in navigating to Google generic website. But I just came to know only a few days before and hence thought I would share the information with others too.
Whenever you type http://www.google.com/, Google automatically tries to redirect you to your country-specific website. For me, it always redirects to http://www.google.co.in/ (Google India). But when we specifically want to navigate to Google Generic website for some reason, there are two ways to accomplish the same.Click the 'Go to Google.com' link at the bottom of the webpage that is displayed from http://www.google.co.in/To prevent this redundant click, you can opt to type http://www.google.com/ncr/ which would prevent the redirect from happening. The NCR stands for No Country Redirect. There is a brief discussion about this NCR over this forum.You may also like to check out Google help documentation regarding the country redirections from here.

Elegant 'MailTo' Replacement

Elegant 'MailTo' Replacement

MailTo tags have become a bane to all websites since spammers run spam robots which crawl the web to capture the email addresses, add to their catalogs and send spams to them. I just thought of sharing with others a simple JavaScript function which would trigger open the default email client instead of having mailto: embedded in the HTML Page.

Just have the following function included in your webpage

<script language='Javascript'>
function WriteMailTo(user,domain)
{
location.replace ('mailto:'+user+'@'+domain);
}
</script>

And whereever you want to invoke the mailto, just called WriteMailTo('user','example.com') and the user's default email client should be launching (if configured) without any hassles.

Contacts import utility from Web2Project to Addressbook

I have been using Web2Project for planning my personal and professional tasks for a few years now. Now I have bifurcated the tools into the following:

Project PierAddress Book The only issue I had was to import my addressbook from Web2Project to AB. PP is a different animal. It does not serve as a comprehensive candidate for addressbook and hence I needed this bifurcation. 
I wrote up a following simple script to import the contacts to AB. The pre-requisite for this script is to hop on to PhpMyAdmin, export the contacts as a PHP array and then  modify the path in our import script to whatever you downloaded from PhpMyAdmin.
Our import script would explode the entries as SQL scripts into the browser window. Copy them and execute into PhpMyAdmin AB database to have the contacts imported.

Script URL: https://gist.github.com/lavanyadeepak/5177500#file-import-php