• C++
  • C++ Guidelines
  • C++ Grade Calculation
  • C++ Sample Program
• Java
  • Java Guidelines
  • Java Grade Calculation
  • Java Sample Program

C++ Guidelines

Comments:

• Include a comment as the first lines of each file. It must start on the first line of the file
  • Start the comment with /*
  • Include at least a one line description
  • Include a blank line
  • Include your name after Name:
  • Include the date after Date:
  • End the comment with */

    /*
     * Description of the class/file
     * ...(if description is long and needs multiple lines)
     *
     * Name:	Karen Peterson
     * Date:	January 1, 2018
     */ 
    

• Include a comment before each function/method.
  • Start the comment with /*
  • Include at least a one line description of the method
  • Include a blank line
  • Include one line for each parameter to the function/method starting with Parameter:
  • Include one line describing what is returned starting with Return:
  • End the comment with */

    /*
     * Description of the method
     *
     * Parameter: 	a	first number
     * Parameter: 	b	second number
     * Return:		sum of two parameters
     */
    public int sum(int a, int b)
    {
    	...
    }
    

  • Note that constructors/destructors have no Return: section

Includes:

• All < > includes must appear before any " " includes

Structured Programming:

• No global variables
• No continue or goto statements
• break statement is acceptable:
  • in switch statements
  • in a loop if there is a comment on the line prior to break; describing why you are choosing to use unstructured programming

Naming Conventions:

• Classes, structs, and enums start with an uppercase letter, then camel-case

  public class MyClass
  

• Enum values are only uppercase, digits, and underscores (no lowercase characters)

  enum Color { RED, GREEN, BLUE }; 
  

• Functions/Methods start with a lowercase letter, then camel-case

  public int myFunction(int a, int b)
  

• Variables start with a lowercase letter, then camel case

  int myVariable;
  

• Constants are only uppercase, digits, and underscores (no lowercase characters)

  const int MAX = 10;
  

Indentation:

• When required, indent by 1 tab or 4 spaces. All tabs will be considered equivalent to 4 spaces
• Lines between { and } will be indented an additional tab
• The switch statement will indent the code for each case one additional tab

  switch (num)
  {
  	case 0:
  		num = num * 2;
  		break;
  	case 1:
  		num = num * 3;
  		break;
   	default:
  		num = num * 4;
  		break;
  }
  

• Within a class, the lines following public:, private:, protected: will be indented one additional tab.

  class MyClass
  {
  	private:
  		int num;
  	public:
  		int myMethod();
  };
  

• If a statement is long and you want to continue it across more than one line, each subsequent line will be indented the same or more

  myVar = num1 + num2 + num3 +
      num4;
  

Spacing:

• Put a space on each side of binary operators
  • +, -, *, /, %, ==, !=, <, >, <=, >=, &&, ||, =, +=, -=, *=, /=, %=

    num1 = num2 + num3;
    

• No space between unary operator and the identifier

  num1 = -num2;
  

• No space between ++, --, ! and its variable/expression

  num1++;
  

• Put a space between if, while, for, catch, switch and the opening (

  if (a < b)
  

• No space between a method name and its opening (

  myFunction(a, b);
  

• No more than a single blank line should be used to separate sections of your code
• Put a space after each comma when listing parameters/arguments/values

  myFunction(a, b);
  

• No space between object, . or -> and member

  myObj.print();
  

Curly Braces:

• Curly braces will always be included, even when optional (for example, if, else, while, for with only 1 statement)

  if (a > 5) 
  {
  	a = a * 2;
  }
  

• Opening curly braces, (, will be on the next line
  • No additional characters (other than comments) may appear after the {

  for (int i = 0; i < 3; i++) 
  {
  	sum += i;
  }
  

• Closing curly braces, }, will be on a line by itself
  • Exception:
    • while (when part of a do-while)
    • ; after the } of class or struct definition

    if (a > 5) 
    {
    	a = a * 2;
    }
    
    if (a > 5) 
    {
    	a = a * 2;
    }
    else if (a < 3) 
    {
    	a = a * 4;
    }
    
    do 
    {
    	a = a * 2;
    } while (a < 20);
    

Variables:

• Only one variable may be declared per statement
• Declare constants before other variables

Functions/Methods:

• If a file contains main(), then it should be the first method listed in the file

Additional Style Requirements:

• Arrays:
  • The size of the array should not be a literal. It will typically be a constant.

    int array[MAX];
    

• Boolean comparison:
  • There is no need to have == or != true or false. If flag is a boolean variable, then
    • if (flag) is equivalent to if (flag == true)
    • if (!flag) is equivalent to if (flag == false)
• nullptr versus NULL:
  • Use nullptr instead of NULL
• Code after case's in a switch:
  • Do not put any code on the same line as a case within a switch
• Do not put more than one statement on a single line

C++ Grade Calculation

There are 11 categories. Nine of them are 10 points each and the remaining two are 5 points each.

• (10) File Comments:
  • If 1 file submitted:
    • 10/10 – present and formatted correctly
    • 7/10 – formatted incorrectly
    • 0/10 – not present
  • If more than 1 file submitted:
    10/10 – zero missing and zero formatted incorrectly
    • 7/10 – one or less missing and two or less formatted incorrectly
    • 4/10 – two or less missing and three or less formatted incorrectly
    • 0/10 – more than 2 missing or 3 formatted incorrectly
(10) Function/Method Comments:
• If 1 function/method submitted:
  • 10/10 – present and formatted correctly
  • 7/10 – formatted incorrectly
  • 0/10 – not present
• If more than 1 functions/methods submitted:
  • 10/10 – zero missing and zero formatted incorrectly
  • 7/10 – one or less missing and two or less formatted incorrectly
  • 4/10 – two or less missing and three or less formatted incorrectly
  • 0/10 – more than 2 missing or 3 formatted incorrectly
• (5) includes:
  • If 1 file submitted:
    • 5/5 – all correct include order
    • 0/5 – incorrect order
  • If more than 1 file submitted:
    • 5/5 – all correct include order
    • 3/5 – one incorrect include order
    • 0/5 – more than two incorrect include order
• (10) Globals/continue/goto/break:
  • 10/10 – no issues
  • 5/10 – 1 issue
  • 0/10 – more than 1 issue
• (10) Proper case for functions, classes, constants, variables, enums:
  • 10/10 – no issues
  • 7/10 – 1 issue
  • 4/10 – 2 issues
  • 0/10 – 3 or more issues
• (10) Proper indentation:
  • 10/10 – no issues
  • 7/10 – 1 issue
  • 4/10 – 2 issues
  • 0/10 – 3 or more issues
• (10) Proper spacing (around operators, too many blank lines, space between function name and (, space after if, while, for, …):
  • 10/10 – no issues
  • 7/10 – 1 issue
  • 4/10 – 2 issues
  • 0/10 – 3 or more issues
• (10) Brace formatting (missing {}'s, do-while formatting, characters after {}, {} in wrong location):
  • 10/10 – no issues
  • 7/10 – 1 issue
  • 4/10 – 2 issues
  • 0/10 – 3 or more issues
• (10) Declarations (constants after other declarations, multiple variables per line):
  • 10/10 – no issues
  • 7/10 – 1 issue
  • 4/10 – 2 issues
  • 0/10 – 3 or more issues
• (5) Function/method order (main is not first function/method in file):
  • 5/5 – main is first
  • 0/5 – main was not first
• (10) Other issues (literal in declaring array size, using ==/!= true/false, using NULL instead of nullptr, code after case :, more than one statement per line):
  • 10/10 – no issues
  • 7/10 – 1 issue
  • 4/10 – 2 issues
  • 0/10 – 3 or more issues

C++ Sample Program

/*
 * Program to print Hello World
 *
 * Name:	Karen Peterson
 * Date:	January 1, 2018
 */

#include 

using namespace std;

/*
 * main - prints Hello World
 *
 * Return:		status
 */

int main()
{
	cout << "Hello World" << endl;

	return 0;
}

Java Guidelines

Comments:

• Include a comment as the first lines of each file. It must start on the first line of the file
  • Start the comment with /**
  • Include at least a one line description
  • Include a blank line
  • Include your name with the @author tag
  • Include the date with the @version tag
  • End the comment with */

    /**
     * Description of the class/file
     * ...(if description is long and needs multiple lines)
     *
     * @author	Karen Peterson
     * @version	January 1, 2018
     */ 
    

• Include a comment before each method.
  • Start the comment with /**
  • Include at least a one line description of the method
  • Include a blank line
  • Include one line for each parameter to the method using the @param tag
  • Include one line describing what is returned using the @return tag
  • End the comment with */

    /**
     * Description of the method
     *
     * @param 	a	first number
     * @param 	b	second number
     * @return		sum of two parameters
     */
    public int sum(int a, int b) {
    	...
    }
    

Package:

• package line is required

Structured Programming:

• No continue or goto statements
• break statement is acceptable:
  • in switch statements
  • in a loop if there is a comment on the line prior to break; describing why you are choosing to use unstructured programming

Naming Conventions:

• Classes and enums start with an uppercase letter, then camel-case

  public class MyClass {
  

• Enum values are only uppercase, digits, and underscores (no lowercase characters)

  enum Color { RED, GREEN, BLUE }; 
  

• Methods start with a lowercase letter, then camel-case

  public int myFunction(int a, int b) {
  

• Variables start with a lowercase letter, then camel case

  int myVariable;
  

• Constants are only uppercase, digits, and underscores (no lowercase characters)

  final int MAX = 10;
  

Indentation:

• When required, indent by 1 tab or 4 spaces. All tabs will be considered equivalent to 4 spaces
• Lines between { and } will be indented an additional tab
• The switch statement will indent the code for each case one additional tab

  switch (num) {
  	case 0:
  		num = num * 2;
  		break;
  	case 1:
  		num = num * 3;
  		break;
   	default:
  		num = num * 4;
  		break;
  }
  

• If a statement is long and you want to continue it across more than one line, each subsequent line will be indented the same or more

  myVar = num1 + num2 + num3 +
      num4;
  

Spacing:

• Put a space on each side of binary operators
  • +, -, *, /, %, ==, !=, <, >, <=, >=, &&, ||, =, +=, -=, *=, /=, %=

    num1 = num2 + num3;
    

• No space between unary operator and the identifier

  num1 = -num2;
  

• No space between ++, --, ! and its variable/expression

  num1++;
  

• Put a space between if, while, for, catch, switch and the opening (

  if (a < b) {
  

• No space between a method name and its opening (

  myFunction(a, b);
  

• No more than a single blank line should be used to separate sections of your code
• Put a space after each comma when listing parameters/arguments/values

  myFunction(a, b);
  

• No space between object, . and member

  myObj.print();
  

Curly Braces:

• Curly braces will always be included, even when optional (for example, if, else, while, for with only 1 statement)

  if (a > 5) {
  	a = a * 2;
  }
  

• Opening curly braces, (, will be on the same line
  • No additional characters (other than comments) may appear after the {

  for (int i = 0; i < 3; i++) {
  	sum += i;
  }
  

• Closing curly braces, }, will be on a line by itself
  • Exception:
    • while (when part of a do-while)
    • else, else if, catch, finally

    if (a > 5) {
    	a = a * 2;
    }
    
    if (a > 5) {
    	a = a * 2;
    } else if (a < 3) {
    	a = a * 4;
    }
    
    do {
    	a = a * 2;
    } while (a < 20);
    

Variables:

• Only one variable may be declared per statement
• Declare constants before other variables

Methods:

• If a file contains main(), then it should be the first method listed in the file

Additional Style Requirements:

• Arrays:
  • The size of the array should not be a literal. It will typically be a constant (or variable)

    int[] array = new int[MAX]; 
    

• Boolean comparison:
  • There is no need to have == or != true or false. If flag is a boolean variable, then
    • if (flag) is equivalent to if (flag == true)
    • if (!flag) is equivalent to if (flag == false)
• Code after case's in a switch:
  • Do not put any code on the same line as a case within a switch
• Do not put more than one statement on a single line

Java Grade Calculation

There are 11 categories. Nine of them are 10 points each and the remaining two are 5 points each.

• (10) File Comments:
  • If 1 file submitted:
    • 10/10 – present and formatted correctly
    • 7/10 – formatted incorrectly
    • 0/10 – not present
  • If more than 1 file submitted:
    10/10 – zero missing and zero formatted incorrectly
    • 7/10 – one or less missing and two or less formatted incorrectly
    • 4/10 – two or less missing and three or less formatted incorrectly
    • 0/10 – more than 2 missing or 3 formatted incorrectly
(10) Function/Method Comments:
• If 1 function/method submitted:
  • 10/10 – present and formatted correctly
  • 7/10 – formatted incorrectly
  • 0/10 – not present
• If more than 1 functions/methods submitted:
  • 10/10 – zero missing and zero formatted incorrectly
  • 7/10 – one or less missing and two or less formatted incorrectly
  • 4/10 – two or less missing and three or less formatted incorrectly
  • 0/10 – more than 2 missing or 3 formatted incorrectly
• (5) Package/includes:
  • If 1 file submitted:
    • 5/5 – all correct (package present)
    • 0/5 – not present
  • If more than 1 file submitted:
    • 5/5 – all correct (package present)
    • 3/5 – one package missing
    • 0/5 – more than two missing packages
• (10) continue/goto/break:
  • 10/10 – no issues
  • 5/10 – 1 issue
  • 0/10 – more than 1 issue
• (10) Proper case for methods, classes, constants, variables, enums:
  • 10/10 – no issues
  • 7/10 – 1 issue
  • 4/10 – 2 issues
  • 0/10 – 3 or more issues
• (10) Proper indentation:
  • 10/10 – no issues
  • 7/10 – 1 issue
  • 4/10 – 2 issues
  • 0/10 – 3 or more issues
• (10) Proper spacing (around operators, too many blank lines, space between function name and (, space after if, while, for, …):
  • 10/10 – no issues
  • 7/10 – 1 issue
  • 4/10 – 2 issues
  • 0/10 – 3 or more issues
• (10) Brace formatting (missing {}'s, do-while formatting, characters after {}, {} in wrong location):
  • 10/10 – no issues
  • 7/10 – 1 issue
  • 4/10 – 2 issues
  • 0/10 – 3 or more issues
• (10) Declarations (constants after other declarations, multiple variables per line):
  • 10/10 – no issues
  • 7/10 – 1 issue
  • 4/10 – 2 issues
  • 0/10 – 3 or more issues
• (5) Function/method order (main is not first function/method in file):
  • 5/5 – main is first
  • 0/5 – main was not first
• (10) Other issues (literal in declaring array size, using ==/!= true/false, code after case :, more than one statement per line):
  • 10/10 – no issues
  • 7/10 – 1 issue
  • 4/10 – 2 issues
  • 0/10 – 3 or more issues

Java Sample Program

/**
 * Program to print Hello World
 *
 * @author	Karen Peterson
 * @version	January 1, 2018
 */
package proj01;

public class HelloWorld {
    /*
     * main - prints Hello World
     *
     * @param	args	command line arguments
     * @return	N/A
     */
    public int main(String[] args) {
        System.out.println("Hello World!");
    }
}