Whitepapers

The KindSoftware Coding Standards

Table of Contents:

1. Introduction
2. Documentation
3. Naming Conventions
4. Semantic Properties
5. Tools
6. Code Examples
7. References
8. Specific Recommendations for:
   1. Java
   2. Eiffel
9. Credits

Naming Conventions

You can name temporary and loop variables anything you like. We suggest prefixes of "temp" for temporary variables and "loop" for loop indices.

All other constructs, especially types and attributes of your objects and parameters of modules, must have some sort of uniform naming scheme. Different programming languages have different standard conventions, thus we specify details in the specific language sections near the end of this document.

In general, all variables names should have semantic value. They should not be bound to type or class since that might change over time but the semantics will (should) not.