{"id":32,"date":"2007-05-10T13:41:07","date_gmt":"2007-05-10T21:41:07","guid":{"rendered":"http:\/\/stevenrbrandt.com\/wordpress\/?p=32"},"modified":"2007-05-10T13:41:07","modified_gmt":"2007-05-10T21:41:07","slug":"coding-conventions","status":"publish","type":"post","link":"https:\/\/stevenrbrandt.com\/?p=32","title":{"rendered":"Coding Conventions"},"content":{"rendered":"

It is important to follow standard naming conventions when writing code. It increases clarity and readability. Thus, in the "Elements of Java Style,"<\/a>\"\" we are told to capitolize class names but not function names, etc. A recent elaboration on this basic idea was put forward by a colleague of mine (Adam French) and his associate (Andrew France).<\/p>\n

The suggestion is that, in addition to other style considerations, your object oriented code should operate as follows:<\/p>\n

    \n
  1. All variables should be named after Star Wars characters.\n
  2. All function names should be named after Star Trek characters.\n
  3. All classes should be named after Lord of the Rings characters.\n<\/ol>\n

    Coding in this fashion will, obviously, require great discipline and nerdity, but in the end the resulting clarity will bring many rewards. And if you are planning to become ISO 9000 certified, remember to document this procedure.<\/p>\n

    Share this:<\/h3>