Team Silent Mission Coding Standards
Date: Tuesday April 5, 2005
Team Silent Mission
Jenny Greenwood, Shannon Whitaker, Brittney Brown, Zack Douglas
Coding Languages
- All coding will be done using Java (servlets, applets), HTML (web pages), SQL (Oracle database), and Swing (Java gui).
Classes
- All Java bean names end with "bean".
- All web Java class names will be lower case.
- All applet Java class names will have each word capitalized.
- Classes will be named according to their purpose or use.
Functions
- All function names will begin with a lowercase letter, and each following conjoined word will have the initial letter capitalized.
- Java JSP, Servlet, and Bean code will use "end line" bracketing.
- Java Applets will use "new line" bracketing.
- Functions will be named to convey their functionality.
Database
- The database used is Oracle.
- All database tables will have a primary key.
- All database table names will be words separated by underscores.
- All column names will be words separated by underscores.
- Column and table names will be kept as short as possible while maintaining clarity with the name.
- Each primary key (if numerical) will end with _ID.
- Each primary key will be set up as a sequence with a trigger on insert to facilitate proper unique identification by primary key.
Variables
- Variable names will be either a combination of words separated by underscores, or a combination of words separated with capitalized first letters of inner words.
- Variable names referencing database variables will match database column names.
- Variable names will be self-documenting and their purpose or usage clear.
Comments
- Comments will be used as necessary.
- Comments will be used where the purpose of the code is not clear or to mark necessary but incomplete functionality.
- Comments will be created according to the language standard.
Source Files
- Source files will be named in a manner that conveys the purpose of the source code.