Home > Articles > Programming

  • Print
  • + Share This
Like this article? We recommend

Like this article? We recommend

Coding Standards Table of Contents

When developing coding standards, it's important to ensure that they're comprehensive and cover all the different scenarios, objects/components, scripts, and so forth that may arise in the environment. This is one reason that it's a good idea to adopt/conform to one of the published sets of standards rather than to create your own.

However, if you decide to write your own standards, or even simply to extend those that already exist, the following checklist may help you to list the areas to cover in your own standards:

  • Overview of technical and applications architecture

  • Which language to use for which purpose

  • Which object type to use for which purpose

  • Naming of namespaces

  • Formatting source code:

  • Indenting

  • Wrapping lines

  • General layout

  • Brackets/braces

  • Commenting—should include templates for headers, etc. as appropriate

  • Naming of variables/properties:

  • Constants

  • Scope—e.g., global/module/class/package

  • Types—e.g., String, int, char, Boolean

  • Naming of functions/methods

  • Naming of files:

  • Capitalization

  • Extensions

  • Naming of directories:

  • Structure

  • Capitalization

  • Naming of (security) roles

  • Source code control

  • Portability issues

  • Localization/internationalization issues

  • Documenting changes/change logs

  • Standard error handling

  • Standard session timeout handling

  • Standard help facilities

  • Look-and-feel/GUI design

  • Configuration information (registry variables, etc.)

  • + Share This
  • 🔖 Save To Your Account