Coding standards

Coding standards
Prev	Chapter 16. Basic concepts	Next

A great effort was spent to write Obliquid in a tidy and organized way, so try to keep things tidy by following this coding standards, and by using common sense.

Indenting: use an indent of 4 spaces, with no tabs. Be sure that tabs are automatically expanded to four spaces in your editor. In Emacs do the following:
```
    (setq c-basic-indent 4)
    (setq tab-width 4)
    (setq indent-tabs-mode nil)
    
```
In vim write the following into your .vimrc:
```
    set shiftwidth=4
    set expandtab
    set tabstop=4
    
```
File format: when committing from windows use a dos file format and when committing from unix use a unix file format. In vim write the following commands to convert from dos to unix file format:
```
    :set ff=unix
    :w
    
```
To convert from unix to dos file format use :set ff=dos instead.
Control structures: control statements should have one space between the control keyword and opening parenthesis, to distinguish them from function calls. You are strongly encouraged to always use curly braces even in situations where they are technically optional. Having them increases readability and decreases the likelihood of logic errors being introduced when new lines are added.
Function Calls: Functions should be called with no spaces between the function name, the opening parenthesis, and the first parameter; spaces between commas and each parameter, and no space between the last parameter, the closing parenthesis, and the semicolon.
Comments: user phpDocumentor syntax. Be descriptive. Even comments within code are strongly encouraged. Use English so everybody in the project will be able to understand them.
PHP Code Tags: Always use <?php to start PHP code, not the <? shorthand. This is the most portable way to include PHP code on differing operating systems and setups. Don't use the PHP closing tag ?> whenever possible, since adding extra lines after it causes the infamous headers already sent problem.

Prev	Up	Next
CVS Access	Home	Naming convenction