Skip to content

Commit d490643

Browse files
committed
Update README.md
1 parent 7ba538f commit d490643

File tree

1 file changed

+8
-1
lines changed

1 file changed

+8
-1
lines changed

README.md

Lines changed: 8 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -176,7 +176,7 @@ if(condition){
176176
}
177177
```
178178

179-
http://en.wikipedia.org/wiki/Indent_style#Variant:_1TBS
179+
Prefer the One true bracing style. It is also used by Apple. : http://en.wikipedia.org/wiki/Indent_style#Variant:_1TBS
180180

181181
```swift
182182
if condition {
@@ -211,3 +211,10 @@ if (condition) {
211211

212212
When returning early prefer ''guard'' over ''if''.
213213

214+
####Comments
215+
216+
Preffer writing self explicit code which doesn't require comments. Comments suffer from rot and become obsolete soon after being written. Write comments only when you code fails to express itself.
217+
218+
IMPORTANT: If your code may create confusion for other developers, leaving a comment is mandatory.
219+
220+
Exception: comments used to generate documentation

0 commit comments

Comments
 (0)