Coding Style
------------
Header files:
-------------------------------
Layout:
Copyright
Header guard
Includes
Defines
Declare namespace
Forward declarations
Class declarations
Example ClassName.h:
-------------------------------
// BlockyFroggy
// Copyright © 2017 John Ryland.
// All rights reserved.
#pragma once
#ifndef CLASS_NAME_H
#define CLASS_NAME_H
namespace NameSpace
{
class ClassName
{
public:
void memberFunction(int a_arg);
private:
int m_memberVariable;
};
}
#endif // CLASS_NAME_H
Source files:
-------------------------------
Layout:
Copyright
Includes
Using namespace
Class definitions
Example ClassName.cpp
-------------------------------
// BlockyFroggy
// Copyright © 2017 John Ryland.
// All rights reserved.
#include "ClassName.h"
using NameSpace;
void ClassName::memberFunction(int a_arg)
{
if (someFunction())
{
m_memberVariable = 1;
return;
}
}