| Chapter 29. Coding Style Guide | ||
|---|---|---|
 |  | |
| Chapter 29. Coding Style Guide | ||
|---|---|---|
| | | |
Table of Contents
(Version as of 2010/04/22.)
Aspects covered in this chapter:
Legend:
(!) - Major rule: It is really important that your code conforms to these rules. You must have a very good justification for the violation of a major rule.
(+) - Minor rule: Conformance to these rules is important, but there may be common situations in which the violation of a minor rule is well justified. It is not allowed, however, to violate a minor rule without a good reason.
Meta Rules
(!) M1: Existing, non-compliant code should be adapted when large changes are applied. Consider refactoring.
(!) M2: Changes to other people's code should preserve their style closely.
(!) M3: Personal source code does not fall under this Coding Style Guide, but it is good practice to consider this guide's rules in personal code as well.
(!) 01.01: Write everything in English (comments, names, variables, documentation...).
(!) 01.02: Be consistent. Even if you decide not to follow some of the rules, do it at least consistently. Never produce code with different styles of programming.
(!) 01.03: Insert the copyright placeholder and the recommended file header at the top of files. Do not use old copyright headers.
© 2024 MeVis Medical Solutions AG
| | | |
| 28.3. Environment variables |  | 29.2. Naming Conventions |