Friday, December 18, 2009

Coding Standards


 Coding Standards:
  1. All the methods name whether it is in java script or java methods start with a small letter and the second word starts with a capital letter.
  2. All the java classes start with a capital letter.
  3. The name of the methods or classes is a verb showing its functionality.
  4.  All the variable names are understandable nouns or verbs.
  5. All the variables have been assigned some default values.
  6. Every function has a description as of what it does and explaining the parameters.
  7. There will be comments in the code whenever it is necessary to describe.
  8. Inline comments to show the end of control statements.
  9. 3 spaces indentation is provided.
  10. As part of file organization , al the css and javascript files are placed in css and js folders respectively besides html codes.
  11. The WEB-INF has classes folder which contains the classes.
  12. Error handling is done using try catch statements of java code.
  13. Where ever necessary we are using the relative path names and not the absolute path names.
  14. When ever there are some reusable components , they are placed in separate file so that they can be included as part of header files.


No comments:

Post a Comment