-
-
Notifications
You must be signed in to change notification settings - Fork 467
Commit
This commit does not belong to any branch on this repository, and may belong to a fork outside of the repository.
Add common naming/formatting conventions.
- Loading branch information
Pavel Kovalenko
committed
Oct 2, 2014
1 parent
aa4df06
commit 476fe66
Showing
1 changed file
with
22 additions
and
0 deletions.
There are no files selected for viewing
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,22 @@ | ||
TITLE: Common conventions | ||
|
||
File and directory names: | ||
- Unless otherwise specified, use lower_case. | ||
- Source code files and VS projects: use PascalCase. | ||
- When you need to define the same entity with several files, you can use lowercase suffixes: | ||
BAD (both files implement the same Matrix44 class, but differ in implementation details) | ||
Matrix44xm.hpp | ||
Matrix44noxm.hpp | ||
GOOD | ||
Matrix44_xm.hpp | ||
Matrix44_noxm.hpp | ||
|
||
- Keep it simple. | ||
- VS projects that represent engine modules should have 'xr' prefix in their names. | ||
- VS projects and their root directories should have the same names. | ||
|
||
Formatting (for text files in /doc/ directory): | ||
- Shift width (indentation) is 2 spaces. | ||
- Never use tabs. | ||
- Line size is 120 columns. | ||
- File should begin with 'TITLE: ' followed by document title. |