Skip to content

[REMOVE] t_ #2

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Open
wants to merge 1 commit into
base: master
Choose a base branch
from
Open

[REMOVE] t_ #2

Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
64 changes: 30 additions & 34 deletions _common/code_standards.markdown
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -93,26 +93,22 @@ All folders should be named in `snake_case` style.

Name private data with a `m_` prefix to distinguish it from public data.

#### Distinguish Function Parameters

Name function parameters with an `t_` prefix.

#### Well formed example

```cpp
class MyClass
{
public:
MyClass(int t_data)
: m_data(t_data)
MyClass(int data)
: m_data(data)
{
}

int GetData() const
{
return m_data;
}

private:
int m_data;
};
Expand Down Expand Up @@ -183,26 +179,26 @@ int MyFuncton()
```cpp
// Bad Idea
int MyFuncton() {

}
```

### 4 spaces indent level.
### 4 spaces indent level.

Spaces are not allowed, and a mixture of tabs and spaces is strictly forbidden. Modern autoindenting IDEs and editors require a consistent standard to be set.

```cpp
// Good Idea
int MyFunction(bool t_b)
int MyFunction(bool b)
{
if (t_b)
if (b)
{
// do something
}
}
```

### {} are required for blocks.
### {} are required for blocks.
Leaving them off can lead to semantic errors in the code.

```cpp
Expand All @@ -218,8 +214,8 @@ int sum = 0;
for (int i = 0; i < 15; ++i)
++sum;
std::cout << i << std::endl;


// Good Idea
// It's clear which statements are part of the loop (or if block, or whatever)
int sum = 0;
Expand All @@ -236,15 +232,15 @@ for (int i = 0; i < 15; ++i)
// Bad Idea
// hard to follow
if (x && y && MyFunctionThatReturnsBool() && caseNumber3 && (15 > 12 || 2 < 3))
{
{
}

// Good Idea
// Logical grouping, easier to read
if (x && y && MyFunctionThatReturnsBool()
&& caseNumber3
if (x && y && MyFunctionThatReturnsBool()
&& caseNumber3
&& (15 > 12 || 2 < 3))
{
{
}
```

Expand All @@ -259,7 +255,7 @@ if (x && y && MyFunctionThatReturnsBool()
#include <includes/MyHeader.hpp>

// Worse Idea
// requires potentially even more specific -I directives and
// requires potentially even more specific -I directives and
// makes code more difficult to package and distribute
#include <string>
#include <MyHeader.hpp>
Expand All @@ -280,9 +276,9 @@ if (x && y && MyFunctionThatReturnsBool()
class MyClass
{
public:
MyClass(int t_value)
MyClass(int value)
{
m_value = t_value;
m_value = value;
}

private:
Expand All @@ -292,13 +288,13 @@ private:

// Good Idea
// C++'s memeber initializer list is unique to the language and leads to
// cleaner code and potential performance gains that other languages cannot
// cleaner code and potential performance gains that other languages cannot
// match
class MyClass
{
public:
MyClass(int t_value)
: m_value(t_value)
MyClass(int value)
: m_value(value)
{
}

Expand Down Expand Up @@ -334,7 +330,7 @@ There is almost never a reason to declare an identifier in the global namespaces

### Namespaces In Source Files

Don't do
Don't do

```cpp
void my_namespace::my_nested_namespace::MyClass::MyFunction()
Expand All @@ -347,7 +343,7 @@ Instead do:
```cpp
namespace my_namespace::my_nested_namespace
{

void MyClass::MyFunction()
{
}
Expand Down Expand Up @@ -418,7 +414,7 @@ delete myobj;

// Good Idea
std::shared_ptr<MyClass> myobj = make_shared<MyClass>();
// ...
// ...
// myobj is automatically freed for you whenever it is no longer used.
```

Expand All @@ -430,7 +426,7 @@ Please no that a smart pointer only shoulbe be passed by reference or const refe
Global data leads to unintended sideeffects between functions and can make code difficult or impossible to parallelize. Even if the code is not intended today for parallelization, there is no reason to make it impossible for the future.


### Prefer pre-increment to post-increment
### Prefer pre-increment to post-increment
... when it is semantically correct. Pre-increment is [faster](http://blog2.emptycrate.com/content/why-i-faster-i-c) then post-increment because it does not require a copy of the object to be made.

```cpp
Expand Down Expand Up @@ -459,12 +455,12 @@ for (int i = 0; i < 15; ++i)
class MyClass
{
public:
MyClass(std::string t_value)
: m_value(t_value)
MyClass(std::string value)
: m_value(value)
{
}

std::string get_value()
std::string get_value()
{
return m_value;
}
Expand All @@ -478,8 +474,8 @@ private:
class MyClass
{
public:
MyClass(const std::string &t_value)
: m_value(t_value)
MyClass(const std::string &value)
: m_value(value)
{
}

Expand Down