Coding Conventions

A coding standards document tells developers how they must write and present their code. Since the standard set is going to remain the same, its always a good practice to follow the coding standards so that its gonna make things easier to undersatand and more clear to the other developers working on the same application. Instead of each developer coding in their own preferred style, they will write all code to the standards outlined by the organisation or team. This makes sure that a large project is coded in a consistent style and parts are not written differently by different programmers. Not only does this solution make the code easier to understand, but also ensures that any developer who looks at the code will be able to get a clear picture on the structure of entire application.

Following are the coding conventions that we will be followed by our team:

1.1 Naming conventions :

1.2 Layout files :

Layout files should match the name of the Android components that they are intended for. Example : if we are creating a layout for the LoginActivity, the name of the layout file should be activity_login.xml.

1.3 Values files :

Resource files in the values folder should be plural,
Example : strings.xml, styles.xml, colors.xml, dimens.xml, attrs.xml

1.4 File import :

While importing a file, the import statement should have the complete file name prefixed by its package name.
Example : import com.example.sony.homeMain.MainActivity;

1.5 Exception handling :

All possible and expected exceptions are to be handled by using a try catch block with appropriate exceptions in the catch block
Example :
try {
// Protected code
}catch(ExceptionName e1) {
// Catch block
}

1.6 Space indentation :

4 space indents should be used for blocks.
Example :
if (switchState == true) {
//content
}

1.7 Brace style :

Braces go on the same line as the code. If the condition has multiple statements, it should be covered inside the braces.
Example :
If (isPinValid) {
Intent intent = new Intent(this, MainActivity.class );
startActivity(intent);
} else {
Intent intent = new Intent(this, LoginToHome.class);
startActivity(intent);
}

1.8 Logging :

Logging methods has to be used since we work as a team. We might not know whose file throws an error. If all these are captured in a log it will be quite useful for fellow developers.
Example :
public validatePin() {
Log.e(TAG, "Inside validate PIN method");
}

1.9 XML style rules :

ID of an XML element should have its asset type as prefix.
Example : button_login

If an XML element doesn't have any content, its a good practice to use self closing tags
Example :
< Spinner
android:id="@+id/txnCategory"
android:layout_width="220dp"
android:layout_height="50dp"/>

1.10 Annotations style :

Annotations should be written just above the method declaration and only one annotation per line
Example :
@override
public void onCreate(SQLiteDatabase db) {
SqliteHelper.onCreate(db);
}

1.10 Code format :

Code has to be formated using Ctrl+Alt+l once coding is completed. Before declaring a method one should always follow the practice of adding comments about what the method does.

Question is how do we make sure that all code adeheres to the coding conventions?

To whom is our MoneyTracker Application more suitable?

Money Tracker is general purpose application suitable for every individual who is concerned to maintain or track the expenditure, none the less certain pre-requisites are, one willing to use the application has to be aware about usage of mobile phones, installation of android applications. This application can be better utilized by the pupils with age > 8 years, since it involves mathematically calculated results and representation of expenditure and savings interms of graph and Pie charts. This application is only focused for individuals who wish to track their day to day expenses, not for group of people or doesn't target large scale industrial expenditure maintainance

So considering the above factors we can define the two personas whom the application is more suitable is as follows:

1. Site Engineer

2. Site Manager

Mockup of MoneyTracker application

Below is the prototype of Money Tracker application

Home screen :

Add transaction screen :

Story board of MoneyTracker application