diff options
author | dundargoc <gocdundar@gmail.com> | 2022-10-14 18:22:34 +0200 |
---|---|---|
committer | dundargoc <gocdundar@gmail.com> | 2022-10-21 16:23:33 +0200 |
commit | a11e96edfc2dec57be5773b6ce64a1323ce8431d (patch) | |
tree | 91d74115f420dcf9313c6fa62e6f6dcd630aa7e2 | |
parent | 6ff245732a5a8ab821598a38fb0c5805e6bd3779 (diff) | |
download | rneovim-a11e96edfc2dec57be5773b6ce64a1323ce8431d.tar.gz rneovim-a11e96edfc2dec57be5773b6ce64a1323ce8431d.tar.bz2 rneovim-a11e96edfc2dec57be5773b6ce64a1323ce8431d.zip |
docs(dev-style): remove rules covered by uncrustify
There's no reason for contributors to learn rules that can be automated
away.
-rw-r--r-- | runtime/doc/dev_style.txt | 96 |
1 files changed, 0 insertions, 96 deletions
diff --git a/runtime/doc/dev_style.txt b/runtime/doc/dev_style.txt index 733b9c50c3..6afe2f7ee7 100644 --- a/runtime/doc/dev_style.txt +++ b/runtime/doc/dev_style.txt @@ -782,55 +782,6 @@ example, `"\uFEFF"`, is the Unicode zero-width no-break space character, which would be invisible if included in the source as straight UTF-8. -Function Declarations and Definitions ~ - -Return type on the same line as function name, parameters on the same line if -they fit. - -Functions look like this: > - - ReturnType function_name(Type par_name1, Type par_name2) - { - do_something(); - ... - } - -If you have too much text to fit on one line: > - - ReturnType really_long_function_name(Type par_name1, Type par_name2, - Type par_name3) - { - do_something(); - ... - } - -or if you cannot fit even the first parameter (but only then): > - - ReturnType really_really_really_long_function_name( - Type par_name1, // 4 space indent - Type par_name2, - Type par_name3) - { - do_something(); // 2 space indent - ... - } - -Some points to note: - -- The open parenthesis is always on the same line as the function name. -- There is never a space between the function name and the open parenthesis. -- There is never a space between the parentheses and the parameters. -- The open curly brace is always on the next line. -- The close curly brace is always on the last line by itself. -- There should be a space between the close parenthesis and the open curly - brace. -- All parameters should be named, with identical names in the declaration and - implementation. -- All parameters should be aligned if possible. -- Default indentation is 2 spaces. -- Wrapped parameters have a 4 space indent. - - Function Calls ~ On one line if it fits; otherwise, wrap arguments at the parenthesis. @@ -889,18 +840,6 @@ no name, assume a zero-length name. > interiorwrappinglist2 } }; -Conditionals ~ - -Don't use spaces inside parentheses. > - - if (condition) { // no spaces inside parentheses - ... // 2 space indent. - } else if (...) { // The else goes on the same line as the closing brace. - ... - } else { - ... - } - Loops and Switch Statements ~ Annotate non-trivial fall-through between cases. @@ -921,39 +860,6 @@ execute, simply `assert`: > assert(false); } -Pointer Expressions ~ - -No spaces around period or arrow. Pointer operators do not have trailing -spaces. - -The following are examples of correctly-formatted pointer and reference -expressions: > - - x = *p; - p = &x; - x = r.y; - x = r->y; - -Note that: - - - There are no spaces around the period or arrow when accessing a member. - - Pointer operators have no space after the * or &. - -Boolean Expressions ~ - -When you have a boolean expression that is longer than the standard line -length, keep operators at the start of the line. > - - if (this_one_thing > this_other_thing - && a_third_thing == a_fourth_thing - && yet_another && last_one) { - ... - } - -Also note that you should always use the punctuation operators, such as `&&` -and `~`, rather than the word operators, such as `and` and `compl`. - - Return Values ~ Do not needlessly surround the `return` expression with parentheses. @@ -1001,8 +907,6 @@ Use of horizontal whitespace depends on location. x = -5; // No spaces separating unary operators and their x++; // arguments. if (x && !y) - ... - i = (int)d; // No spaces after a cast operator. < Vertical Whitespace ~ |