Analysis

Overview

Describes what rules the code must follow.

Task requirements

• Describe how the environment must be set up
  • What the warning level should be
  • What plug-ins must be installed
• What naming convention should be used (for example camelCase)
• Define what other rules developers must follow
• Link to related how-tos

Requirements to the task result

The result of this task must be wiki pages.

Implementation idea

Wiki pages must be created for all the necessary setups a developer must do and for code conventions a developer must follow, and these pages must be linked in the implementation part of this task page.

Related

Code Conventions for the JavaTM Programming Language (Sun Microsysytems, Inc. Revised April 20, 1999)

• ​http://java.sun.com/docs/codeconv/
• The most important and with higher priority.

AmbySoft Inc. Coding Standards for Java v17.01d (Last uploaded on January 15, 2000)

• ​http://www.ambysoft.com/downloads/javaCodingStandards.pdf

Java Programming Style Guidelines (Version 6.0, April 2007)

• ​http://geosoft.no/development/javastyle.html

Draft Java Coding Standard written by Doug Lea

• ​http://g.oswego.edu/dl/html/javaCodingStd.html

Java Code Conventions & Code auditors Presented by Ravi Pavagada Pavagada, Haibo Zhao, Justin Milligan, Joe Dawley

• ​http://webster.cs.uga.edu/~pavagada/SoftwareEngineering/JavaCodeConventions.pdf

Note: Most of the coding conventions mentioned above are more or less the same...

How to demo

Check if all necessary information about the setup of the environment and the rules to be followed for the development is linked.

Design

What pages are needed:

• Compiler Settings
• Javadoc conventions
• Naming conventions
• Logging
• Code Tasks Requirements
• What is considered code smell and code smell examples

Implementation

COMPILER_SETTINGS
JAVADOC_CONVENTIONS
NAMING_CONVENTIONS
LOGGING
CODE_TASKS_REQUIREMENTS
CODE_SMELLS

Testing