Clean platform coding style

From Clean
Revision as of 16:21, 22 May 2008 by Bas Lijnse (talk | contribs) (New page: While a certain degree of freedom in writing style is a good thing, the readability of programs improves a lot when a consistent coding style is used. We therefore define the following gui...)
(diff) ← Older revision | Latest revision (diff) | Newer revision → (diff)
Jump to: navigation, search

While a certain degree of freedom in writing style is a good thing, the readability of programs improves a lot when a consistent coding style is used. We therefore define the following guidelines which strongly encourage everyone to use when developing libraries for Clean and are even mandatory for libraries which are part of the Clean platform.


Naming types

The names of types should be clear and informative, and should always start with a capital. If the name of a type consists of multiple words, each new word should start with a capital. The constructors of a type should also start with a capital.

Naming functions

Function names should *not* start with a capital, but when a function consists of multiple words, each new word, except the first one should start with a capital. By starting types and constructors with a capital and, functions without one, the difference between a constructor and a function is immediately clear for the reader of a program.

Naming modules

For modules, the same guidelines apply as for naming types. Names should be informative and preferably short.