2011-10-18 16:52:14 -04:00
|
|
|
Here are the guidelines to follow when coding SuperTuxKart:
|
2007-05-27 12:01:53 -04:00
|
|
|
|
|
|
|
Filenames
|
|
|
|
=========
|
|
|
|
|
|
|
|
The filenames should be, with underscores between words. Use the .cpp
|
|
|
|
extension for C++ implementation files and .hpp for C++ headers, .c for
|
|
|
|
C files and .h for C headers.
|
|
|
|
|
|
|
|
|
|
|
|
Coding style
|
|
|
|
============
|
|
|
|
|
|
|
|
The coding style used in Super Tux Kart can be found at
|
2011-10-18 16:52:14 -04:00
|
|
|
http://supertuxkart.sourceforge.net/Coding_Style
|
2007-05-27 12:01:53 -04:00
|
|
|
|
|
|
|
|
|
|
|
Documentation line length
|
|
|
|
=========================
|
|
|
|
|
2011-10-18 16:52:14 -04:00
|
|
|
All the documentation files should have at most 80 characters, because
|
2007-05-27 12:01:53 -04:00
|
|
|
on some displays and on paper you often are limited to 80 characters, and
|
|
|
|
also under some conditions appendices (for example, line numbers) are
|
|
|
|
added. The exception if the player's manual, because it's long, so to
|
|
|
|
understand it better it should be limited to 65 characters.
|