Code Conventions Overview

Provides a general description of code conventions

In any computer language, code conventions are a set of rules that should be followed when writing program code. They are called conventions because they are not enforced by the compiler, as they are not a part of the language syntax itself. For example, a variable can be named lastName or it can be named lstn01. The first choice is easier to read for humans, but to the compiler either is valid. Think of code conventions as a set of best practices, which under normal circumstances should be adhered to as closely as possible.

As a general rule, the purpose of code conventions is to improve readability and prevent bugs. To the extent that everybody adopts the same conventions when programming, each individual will be able to understand the work of others, and fewer mistakes will be made. This is even the case when a single individual reads his own code many months or years after having written it.

One way to improve readability is to include comments in your code. On the other hand, for the most part code conventions guide the way the code itself is structured. There are a number of ways to make code more readable:

Adhere to variable and object naming conventions
Use explicit variable names
Indent code according to depth within code blocks
Express logical statements in the simplest way possible
Use whitespace to separate program segments

The Studio editor can help you adhere to some of these code conventions using two commands: Indent and Refactor.