slpycatzz / CS3201-T04

A simple Static Program Analyzer (SPA)

Geek Repo:Geek Repo

Github PK Tool:Github PK Tool

Coding convention

slpycatzz opened this issue · comments

Hi guys, here are the coding convention that we are using personally. Some might differ from the Google C++ code style, but in general we are using it for familiarity as we are transiting from Java to C++.

In general we will be using "lowerCamelCase" for all our variables and method names. The only exception is, we will be using "UpperCamelCase" for static methods.

For private variables, for ease of use and readability, we will be appending an underscore to private variables. "thisIsAnExample_".

For file inclusion, you should include the files in alphabetical order, separating the c++ libraries inclusion files from our own inclusion files. This increase readability and overall organization.

Example:

#include <string>
#include <vector>

#include "Constants.h"
#include "Exceptions.h"

Leave any comments below if you feel like introducing any coding convention that you think is beneficial for the team.

Got it!