forked from rayofhope-dev/xray-16
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathcommon.txt
22 lines (19 loc) · 781 Bytes
/
common.txt
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
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):
- Indentation is 2 spaces.
- Never use tabs.
- Line size is 120 columns.
- File should begin with 'TITLE: ' followed by document title.