Skip to content

Coding Standard reference

Joseph Pearson edited this page Jun 13, 2014 · 14 revisions

Graphical User Interface

Control Naming

Every control should be named with the correct prefix, followed by the name of the parents control, then the name of this control, optionally followed by its correct suffix. (See the table bellow)

Control Prefix Suffix
Button BTN_ -
CheckBox CHK_ -
TextBox TXT_ -
DataGridView: DGV_ -
CheckBox CHK_ -
Label: LBL_ -
TabControl: TAB_ -
TabPage: TAB_ _Page
Splitter: SPL_ -
ComboBox: CMB_ -

Code

Member Variable

Member variable should start with the prefix m_ and use camelCase

Comments

Every public components of a class MUST be correctly commented

Whitespace/Indentation

Code indentation should be done with tabs, NOT spaces. This is to prevent Git conflicts due to inconsistent whitespace characters or newlines. Most client-side merge utilities can handle this but the diff/merge tool built into Github cannot.

Clone this wiki locally