File tree Expand file tree Collapse file tree 1 file changed +22
-0
lines changed Expand file tree Collapse file tree 1 file changed +22
-0
lines changed Original file line number Diff line number Diff line change
1
+ TITLE: Common conventions
2
+
3
+ File and directory names:
4
+ - Unless otherwise specified, use lower_case.
5
+ - Source code files and VS projects: use PascalCase.
6
+ - When you need to define the same entity with several files, you can use lowercase suffixes:
7
+ BAD (both files implement the same Matrix44 class, but differ in implementation details)
8
+ Matrix44xm.hpp
9
+ Matrix44noxm.hpp
10
+ GOOD
11
+ Matrix44_xm.hpp
12
+ Matrix44_noxm.hpp
13
+
14
+ - Keep it simple.
15
+ - VS projects that represent engine modules should have 'xr' prefix in their names.
16
+ - VS projects and their root directories should have the same names.
17
+
18
+ Formatting (for text files in /doc/ directory):
19
+ - Shift width (indentation) is 2 spaces.
20
+ - Never use tabs.
21
+ - Line size is 120 columns.
22
+ - File should begin with 'TITLE: ' followed by document title.
You can’t perform that action at this time.
0 commit comments