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

Code Examples

Template code examples are available for the following classifier types. Note that, because you're just going to change them anyway, we elected not to use "com.kindsoftware" package names on the samples.

Java Examples

• Abstract Class
• Normal Class
• Exception Class
• Interface

Also, other code templates are available. The "CodeTests" class is used to test our standards for code structure. The "Javadoc" class contains a list of all Javadoc tags defined in this document. You can load this up into your editor and cut and paste from it when writing new documentation.

• Code Tests class
• Javadoc class

The Javadoc documentation generated from all of the above classes is also available.

Eiffel Examples

A single class template is available that highlights many of the recommendations made in this code standard.