Coding Standards

Naming

• Namespaces, Classes, Functions: PascalCase
• Variables: camelCase

Indentation

Use 4 spaces for indentation, not tabs.

Documentation

All non-private members need to be documented using Doxygen-style comments.

Example

#include <string>
#include <iostream>
#include "Example.hpp"
 
class Fish : public Example {
  public:
 
    Fish(const std::string& name);
    
 
    void DisplayName(bool prefix = false) const;
 
 
    bool GetHappy() const;
 
  private:
    std::string name;
    Fish* nextFish;
}
 
Fish::Fish(const std::string& name) {
    this->name = name;
}
 
void Fish::DisplayName(bool prefix) const {
    if (prefix) {
        std::cout << "A fish called " << name << "." << std::endl;
    } else {
        std::cout << name << std::endl;
    }
}
 
bool Fish::GetHappy() const {
    return true;
}