Apple-2-Tools
/
AppleWin
mirror of https://github.com/AppleWin/AppleWin.git
1
0
Fork 0
Code Issues Projects Releases Wiki Activity

CodingConventions.txt: updated for PR #866

This commit is contained in:
tomcw 2020-11-11 21:56:07 +00:00
parent 01ad5d1882
commit 8811651270
1 changed files with 10 additions and 3 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

13
docs/CodingConventions.txt
View File

@ -30,9 +30,16 @@ This is for shared vars, enums, structs, classes, etc.
EG. const/enum/struct
Obviously not for global funcs or vars.
1.4: PCH (StdAfx.h)
Could ditch this.
Does this gain anything for such a simple project?
1.4: At the start of each header file it must contain: #pragma once
1.5: Each module (.cpp) to include stdafx.h, and then immediately after include
the header file for that module.
EG. For Debug.cpp:
#include "stdafx.h"
#include "Debug."
This ensures that this header file can be included in any order in another module,
and therefore by extension all header files can be included in any order.
-------------------------------------------------------------------------------