forks
/
dlangui
mirror of https://github.com/buggins/dlangui.git
1
0
Fork 0
Code Issues Packages Projects Releases Wiki Activity

some fixes in CODING_STYLE.md

This commit is contained in:
gazer 2016-01-25 23:08:18 +03:00
parent eb99980d5e
commit d8e3da799e
1 changed files with 16 additions and 16 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

32
CODING_STYLE.md
View File

@ -2,37 +2,37 @@ DlangUI Coding Style
==================== ====================
Tabs and indentation Tabs and indentation
==================== --------------------
No Tab characters should be used in source code. No Tab characters should be used in source code.
Use 4 spaces instead of tabs. Use 4 spaces instead of tabs.
Identifiers Identifiers
=========== -----------
Class names: CamelCase with uppercase first letter, e.g.: LinearLayout, GridWidget Class names: CamelCase with uppercase first letter, e.g.: `LinearLayout`, `GridWidget`.
Method and property names: camelCase with lowercase first letter, e.g.: textAlign, layoutWidth Method and property names: camelCase with lowercase first letter, e.g.: `textAlign`, `layoutWidth`.
Private and protected class and struct fields: \_camelCase prepended with underscore, e.g. \_windowWidth Private and protected class and struct fields: \_camelCase prepended with underscore, e.g. `_windowWidth`.
Signal names: camelCase Signal names: camelCase.
Enum member names: currently, 3 styles are used JAVA_LIKE, CamelCase and camelCase TODO: make it consistent? Enum member names: currently, 3 styles are used: JAVA_LIKE, CamelCase and camelCase. TODO: make it consistent?
class MyClass { class MyClass {
private int _x; private int _magicNumber;
@property int x() { return _x; } @property int magicNumber() { return _magicNumber; }
} }
Spaces Spaces
====== ------
Always put space after comma or semicolon if there are more items in the same line. Always put space after comma or semicolon if there are more items in the same line.
update(x, y, isAnimating(this)) update(x, y, isAnimating(this));
auto list = [1, 2, 3, 4, 5]; auto list = [1, 2, 3, 4, 5];
Usually there is no space after opening or before closing [] and () Usually there is no space after opening or before closing `[]` and `()`.
Spaces may be added to improve readability when there is a sequence brackets of the same type. Spaces may be added to improve readability when there is a sequence brackets of the same type.
@ -42,9 +42,9 @@ Use spaces before and after == != && || + - * / etc.
Brackets Brackets
======== --------
Curly braces for if, switch, for, foreach - preferable placed on the same lines as keyword Curly braces for `if`, `switch`, `for`, `foreach` - preferable placed on the same lines as keyword:
if (a == b) { if (a == b) {
} else { } else {
@ -52,13 +52,13 @@ Curly braces for if, switch, for, foreach - preferable placed on the same lines
foreach(item; list) { foreach(item; list) {
writeln(item); writeln(item);
} }
Cases in switch should be indented: Cases in switch should be indented:
switch(action.id) { switch(action.id) {
case 1: case 1:
processAction(1); processAction(1);
break; break;
default: default:
break; break;