Coding Style Guidelines

Medical Technology, Healthcare & Government IT

.
Categories
Category Groups

Coding Style Guidelines

This document describing the preferred coding style, coding style enforcing tools for programming with various languages.

Currently We are focusing on HTML,CSS,JavaScript,XML,PHP,Java, C# and .Net

IDE (Integrated Development Environment)

For all Microsoft technologies use Microsoft Visual studio.

For HTML,JavaScript,XML, Java, PHP developments Prefer Eclipse IDE.

for php use PDT enabled eclipse

Latest eclipse has default support for JavaScript, other wise you can add JavaScript Development Tools to eclipse.

All style guide xmls, which can easily integrate with eclipse available in this link

HTML and CSS

Refer Google HTML/CSS Style Guide and JSLINT HTML/CSS Style

XML

if our project requires create a new XML document format, this XML Document Format Style Guide is helpful. In addition to actual style rules, it also contains advice on designing our own vs. adapting an existing format, on XML instance document formatting, and on elements vs. attributes.

JavaScript

Style Guide

For JavaScript code styling use Style guide with Google. also refer JSLint and JSHint. JSLint is the http://javascript.crockford.com/code.html

Closure Compiler

Google provides a true compiler for JavaScript, Instead of compiling from a source language to machine code, it compiles from JavaScript to better JavaScript. It parses your JavaScript, analyzes it, removes dead code and rewrites and minimizes what’s left. It also checks syntax, variable references, and types, and warns about common JavaScript pitfalls.
The Google Closure Compiler provides warnings for illegal JavaScript and warnings for potentially dangerous operations, helping you to produce JavaScript that is less buggy and easier to maintain.

Google provides another tool named Google Closure Linter, it is a utility that checks JavaScript files for style issues such as operator placement, missing semicolons, spacing, the presence of JsDoc annotations, and more. The How to use Closure Linter will help installation and usage.

PHP

Zend Framework Coding Standard for PHP giving php coding style. Also those who are working in Drupal or wordpress must check Drupal’s php coding style and WordPress coding style.

PHP Coding Standards Fixer tool fixes most issues in our code when we want to follow the PHP coding standards.

C# or .Net

Design Guidelines for Developing Class Libraries for C# and .net described in the MSDN site . Also a great blog explains the coding guide lines .

To enforce a set of style and consistency rules to C# source code stylecop can be add to visual studio editor.It’s rules and guidelines available here

JAVA

For Java coding standards we must use oracle’s coding standards .

To check or enforce the coding standard and coding style with eclipse use the tool named checkstyle

Original Link

Leave a Reply