Difference between revisions of "Code style guidelines"
Jump to navigation
Jump to search
(Created page with "=== General Guidelines === For everybody elses' sanity, please just use something that resembles [https://www.kernel.org/doc/Documentation/CodingStyle the Linux Kernel code st...") |
|||
| Line 1: | Line 1: | ||
=== General Guidelines === | === General Guidelines === | ||
| − | For everybody elses' sanity, please just use something that resembles [https://www.kernel.org/doc/Documentation/CodingStyle the Linux Kernel code style], with the exception that cases in switch statements are indented a level. Much of the already existing code is somewhat weird looking, do not try to replicate that. Use your best judgement for C++ specific syntax. | + | For everybody elses' sanity, please just use something that resembles [https://www.kernel.org/doc/Documentation/CodingStyle the Linux Kernel code style], with the exception that cases in switch statements are indented a level. Much of the already existing code is somewhat weird looking, do not try to replicate that. Use your best judgement for C++-specific syntax. |
=== Do NOT use spaces for indentation === | === Do NOT use spaces for indentation === | ||
=== Do add spaces between operators so they line up (when appropriate) === | === Do add spaces between operators so they line up (when appropriate) === | ||
| Line 8: | Line 8: | ||
* Try to avoid operator overloading | * Try to avoid operator overloading | ||
* Avoid iterators like the plague | * Avoid iterators like the plague | ||
| − | === | + | * Avoid templates unless very convenient |
| + | === Classes === | ||
* Don't put actual code in header files, unless it's a 3-liner or an inline function | * Don't put actual code in header files, unless it's a 3-liner or an inline function | ||
| − | * Class definitions should go in header files | + | * Class definitions should go in header files |
| + | * Substantial (over 4 LoC) methods are defined outside of the class definition | ||
| + | * Class names are PascalCase, method names are camelCase | ||
| + | * Functions not part of any class should be unix_lowercase_underscore_style() | ||
=== Use STL, avoid Irrlicht containers === | === Use STL, avoid Irrlicht containers === | ||
=== Don't let things get too large === | === Don't let things get too large === | ||
| + | * Try to keep lines under 80 characters. It's okay if it goes over by a few, but 90 character lines or larger are definitely unacceptable. | ||
* Functions should not be over 200 LoC - if you are concerned with having to pass too many parameters to child functions, make whatever it is into a class | * Functions should not be over 200 LoC - if you are concerned with having to pass too many parameters to child functions, make whatever it is into a class | ||
* Don't let files get too large (over 1500 LoC) | * Don't let files get too large (over 1500 LoC) | ||
* Currently existing huge files (game.cpp, server.cpp, etc.) are in the slow process of being cleaned up | * Currently existing huge files (game.cpp, server.cpp, etc.) are in the slow process of being cleaned up | ||
Revision as of 18:47, 9 March 2013
General Guidelines
For everybody elses' sanity, please just use something that resembles the Linux Kernel code style, with the exception that cases in switch statements are indented a level. Much of the already existing code is somewhat weird looking, do not try to replicate that. Use your best judgement for C++-specific syntax.
Do NOT use spaces for indentation
Do add spaces between operators so they line up (when appropriate)
Don't be too C++y
- Don't use references when they're not necessary. They are rather inflexible and can be misleading.
- Don't use initializer lists unless absolutely necessary (initializing an object inside a class, or initializing a reference)
- Try to avoid operator overloading
- Avoid iterators like the plague
- Avoid templates unless very convenient
Classes
- Don't put actual code in header files, unless it's a 3-liner or an inline function
- Class definitions should go in header files
- Substantial (over 4 LoC) methods are defined outside of the class definition
- Class names are PascalCase, method names are camelCase
- Functions not part of any class should be unix_lowercase_underscore_style()
Use STL, avoid Irrlicht containers
Don't let things get too large
- Try to keep lines under 80 characters. It's okay if it goes over by a few, but 90 character lines or larger are definitely unacceptable.
- Functions should not be over 200 LoC - if you are concerned with having to pass too many parameters to child functions, make whatever it is into a class
- Don't let files get too large (over 1500 LoC)
- Currently existing huge files (game.cpp, server.cpp, etc.) are in the slow process of being cleaned up