kakoune/doc/coding-style.asciidoc

50 lines
1.1 KiB
Plaintext
Raw Normal View History

2014-10-07 10:19:46 +02:00
C++ Coding Style
================
Kakoune is written in C++14, here are the main coding style points:
2014-10-07 10:19:46 +02:00
2019-11-16 11:27:06 +01:00
* Avoid external dependencies besides posix/stdc++
2014-10-07 10:19:46 +02:00
* 4 spaces for indentation, no tabs
* public interface before private methods/data when defining a class
2016-04-08 18:00:24 +02:00
* use +override+ keyword for overridden virtual methods
2014-10-07 10:19:46 +02:00
* opening brackets on their own lines by default, except when declaring
an object where the opening bracket follows the equal sign.
* use alternative logical operator names (and, or, not instead of &&, ||, !)
2014-10-07 10:19:46 +02:00
-----
int func()
{
if (condition)
{
...
}
else
statement;
}
int array[] = {
...
};
-----
* End lines with an operator when continuing on the next line
----
if (condition1 or
2014-10-07 10:19:46 +02:00
condition2)
----
* Try to keep under 80 columns, even though this is not a strict limit.
* CamelCase for types, snake_case for variables/function names
* prefix fields with m_, static ones with ms_ except for dumb structs
(struct with every field public) where these prefixes can be dropped.
* use const and constexpr liberally