Skip to content
GitLab
Projects
Groups
Snippets
/
Help
Help
Support
Community forum
Keyboard shortcuts
?
Submit feedback
Sign in
Toggle navigation
Menu
Open sidebar
LEFEBVREJP email
radix
Commits
9d14ef59
Commit
9d14ef59
authored
Jan 15, 2017
by
LEFEBVREJP email
Browse files
Adding initial name convention to contribution.md.
parent
d5588bc2
Pipeline
#7408
passed with stages
in 23 minutes and 5 seconds
Changes
1
Pipelines
1
Hide whitespace changes
Inline
Side-by-side
CONTRIBUTING.md
View file @
9d14ef59
...
...
@@ -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;
};
```
Write
Preview
Supports
Markdown
0%
Try again
or
attach a new file
.
Cancel
You are about to add
0
people
to the discussion. Proceed with caution.
Finish editing this message first!
Cancel
Please
register
or
sign in
to comment