Commit 9d14ef59 authored by LEFEBVREJP email's avatar LEFEBVREJP email
Browse files

Adding initial name convention to contribution.md.

parent d5588bc2
Pipeline #7408 passed with stages
in 23 minutes and 5 seconds
......@@ -68,3 +68,37 @@ From the root directory running the following command will load default options
```
astyle --options=options.astyle *.cc *.hh
```
# Naming convention
## File naming
C++ files should end in `.cc` and header files in `.hh`.
Template implementations should end in `.i.hh`.
**File names should be all lowercase with no underscores.**
## Class naming
Classes should be **CamelCase**.
```
class CommandLine
{
};
```
Class members should be prefixed with **m** and be **lazyCamelCase**.
```
class CommandLine
{
private:
int mArgc;
char ** mArgv;
};
```
Class methods should be **lazyCamelCase**.
Class member getter methods should be the members name **lazyCamelCase** `int argc() const`.
```
class Commandline
{
private:
int mArgc;
public:
int argc() const;
int myMethod() const;
};
```
Markdown is supported
0% or .
You are about to add 0 people to the discussion. Proceed with caution.
Finish editing this message first!
Please register or to comment