Coding Standards

1/22/13

Work in progress includes research and selection of suitable markup and coding standards, and modification of existing syntax to bring it into compliance. This will give us a clean body of code to work with, making it easier to understand, add new features, and debug. Standards must be chosen for the following content:

---

HTML/XHTML

The W3C is the final authority on HTML/XHTML. We need to choose a document type, and then model the existing markup after that standard.

Online validator/tidy utilities:

• W3C: Markup Validation Service
• Infohound: HTML Tidy

Local tidy utility:

• Sourceforge: Tidy

PHP

The Zend Framework coding standard for PHP appears to be the most recommended standard to follow. Existing PHP files are currently being modified to bring them more in line with this standard.

Online validators:

• MeanDeviation: PHP Syntax Check
• icosaedro.it: PHPLint Online
• PHP Code Checker

JavaScript

So far, there seem to be a number of standards. We are currently reviewing options, especially Douglas Crockford's "Code Conventions for the JavaScript Language". We seek to utilize one that will be similar in style to the one we use for PHP.

Online validator:

• JSLint

Local validator:

• GitHub: JSLint by Douglas Crockford