Versions Compared

Old Version 1

changes.mady.by.user David E Tanner

Saved on

compared with

New Version Current

changes.mady.by.user Stephen Turner

Saved on

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.
Comment: Migration of unmigrated content due to installation of a new plugin
indent

{color:green}Have any suggestion on how improve this wiki?  Please give us your feedback at [mailto:csf-support@mit.edu]{color}
Panel

Quick Links to:

Table of Contents
minLevel3
Panel

The Educational Systems - Common Services

...

Framework generally follows the code conventions set by the Java programming language that can be found at http://java.sun.com/docs/codeconv/html/CodeConvTOC.doc.html

For the purposes of this document, we'll highlight those areas that seem to be most frequently overlooked, and ways in which we might deviate from the standard.

Panel

Line Length

indent
1
1

Java specifies a line length of 80 characters "since they're not handled well by many terminals and tools."

...

  We find this limitation to be a little outdated.

...

  Modern screens and development environments can easily accommodate many more characters than 80, and limiting to 80 makes code especially unreadable.
Panel

Class and Interface Declarations

indent
1
1

When coding Java classes and interfaces, the following formatting rules should be followed:

...


* No space between a method name and the parenthesis "(" starting its parameter list

...


* Open brace appears at the end of the same line as the declaration statement

...


* Closing brace starts a line by itself indented to match its corresponding opening statement, except when it is a null statement the "}" should appear immediately after the "\{"

...


* Methods are separated by a blank line

...



E.g.,

...


{code
}
class Sample extends Object {
    int ivar1;
    int ivar2;

    Sample(int i, int j) {
        ivar1 = i;
        ivar2 = j;
    }

    int emptyMethod() {}

    ...
}
{code}
Panel

if, if-else, if else-if else Statements

indent
1
1

The if-else class of statements should have the following form:

...


{code
}
if (condition) {
    statements;
}

if (condition) {
    statements;
}
else {
    statements;
}

if (condition) {
    statements;
}
else if (condition) {
    statements;
}
else {
    statements;
}
{code}
Panel

do-while Statements

indent
1
1

A do-while statement should have the following form:

...


{code
}
do {
    statements;
}
while (condition);
{code}
Panel

try-catch Statements

indent
1
1

A try-catch statement should have the following format:

...

Code Block

{code}
try {
    statements;
}
catch (ExceptionClass e) {
    statements;
}

{code}
A try-catch statement may also be followed by finally, which executes regardless of whether or not the try block has completed successfully.

...


{code
}try {
    statements;
}
catch (ExceptionClass e) {
    statements;
}
finally {
    statements;
}
{code}