2.6. Table of Rules

2.6.1. General

Rule

Link

Automated Check

GENERAL:001

Filenames (GENERAL:001)

Yes

GENERAL:002

Filename uniqueness (GENERAL:002)

Yes

GENERAL:003

Encoding (GENERAL:003)

Yes

GENERAL:004

End-of-File (GENERAL:004)

Yes

GENERAL:005

No trailing whitespace (GENERAL:005)

Yes

GENERAL:006

Indentation (GENERAL:006)

Yes

2.6.2. C-Rules

Rule

Link

Automated Check

C:001

Filenames (C:001)

No

C:002

Header (C:002)

Yes

C:003

Line length (C:003)

No

C:004

File level doxygen (C:004)

Yes

C:005

Include guard (C:005)

Yes

C:006

C Sections (C:006)

Yes

C:007

Includes (C:007)

No

C:008

Scoping (C:008)

No

C:009

Function names (C:009)

No

C:010

Function scopes (C:010)

No

C:011

Function doxygen documentation (C:011)

No

C:012

Function return statement (C:012)

No

C:013

Function calls (C:013)

No

C:014

Additional function rules (C:014)

No

C:015

Function parameter checking (C:015)

No

C:016

Variable names (C:016)

No

C:017

Constant names (C:017)

No

C:018

Pointer rules (C:018)

No

C:019

Variable initialization (C:019)

No

C:020

Hexadecimal values (C:020)

No

C:021

Floating-point values (C:021)

No

C:022

Structs (C:022)

No

C:023

Enums (C:023)

No

C:024

Typedefs (C:024)

No

C:025

Macros (C:025)

No

C:026

Conditionals (C:026)

No

C:027

switch Statements (C:027)

No

C:028

loop Statements (C:028)

No

C:029

C Comment style (C:029)

Yes

C:030

General note and common mistakes (C:030)

No

C:031

C Formatting (C:031)

No

C:032

State machines (C:032)

No

C:033

Unit Testing Framework Directives (C:033)

No

2.6.3. Python-Rules

Rule

Link

Automated Check

PYTHON:001

Filenames (PYTHON:001)

No

PYTHON:002

Header (PYTHON:002)

Yes

PYTHON:003

Syntax (PYTHON:003)

No

PYTHON:004

Formatting (PYTHON:004)

No

PYTHON:005

Static program analysis (PYTHON:005)

No

PYTHON:006

No platform specific code (PYTHON:006)

No

PYTHON:007

wscript Specific rules (PYTHON:007)

No

2.6.4. reStructuredText-Rules

Rule

Link

Automated Check

RST:001

Filenames (RST:001)

No

RST:002

Line length (RST:002)

No

RST:003

Include (RST:003)

Yes

RST:004

Links (RST:004)

Yes

RST:005

Headings (RST:005)

Yes

RST:006

Orphan (RST:006)

Yes

RST:007

Sentence (RST:006)

No

2.6.5. Batch and Shell-Rules

Rule

Link

Automated Check

BATCH:001

Filenames (BATCH:001)

No

BATCH:002

Header (BATCH:002)

Yes

SHELL:001

Filenames (SHELL:001)

No

SHELL:002

Header (SHELL:002)

Yes

POWERSHELL:001

Filenames (POWERSHELL:001)

Yes

POWERSHELL:002

Header (POWERSHELL:002)

Yes