Merge pull request #1 from exaring/add-naked-returns

Add-naked-returns

src/SUMMARY.md

@@ -51,6 +51,7 @@
   - [nil is a valid slice](slice-nil.md)
   - [Reduce Scope of Variables](var-scope.md)
   - [Avoid Naked Parameters](param-naked.md)
+  - [Avoid Naked Returns](naked-return.md)
   - [Use Raw String Literals to Avoid Escaping](string-escape.md)
   - Initializing Structs
     - [Use Field Names to Initialize Structs](struct-field-key.md)

src/naked-return.md

@@ -0,0 +1,29 @@
+# Avoid Naked Returns
+
+Naked returns hurt readability and make it harder for the IDE to help you (e.g. when highlighting variable usage).
+
+Always list the return values explicitly.
+
+<table>
+<thead><tr><th>Bad</th><th>Good</th></tr></thead>
+<tbody>
+<tr><td>
+
+```go
+func foo() (x int, err error) {
+  x = 42
+  return 
+}
+```
+
+</td><td>
+
+```go
+func foo() (x int, err error) {
+  x = 42
+  return x, err
+}
+```
+
+</td></tr>
+</tbody></table>

style.md

@@ -58,6 +58,7 @@
   - [nil is a valid slice](#nil-is-a-valid-slice)
   - [Reduce Scope of Variables](#reduce-scope-of-variables)
   - [Avoid Naked Parameters](#avoid-naked-parameters)
+  - [Avoid Naked Returns](#avoid-naked-returns)
   - [Use Raw String Literals to Avoid Escaping](#use-raw-string-literals-to-avoid-escaping)
   - [Initializing Structs](#initializing-structs)
     - [Use Field Names to Initialize Structs](#use-field-names-to-initialize-structs)
@@ -3332,6 +3333,36 @@ const (
 func printInfo(name string, region Region, status Status)
 ```
 
+### Avoid Naked Returns
+
+Naked returns hurt readability and make it harder for the IDE to help you (e.g. when highlighting variable usage).
+
+Always list the return values explicitly.
+
+<table>
+<thead><tr><th>Bad</th><th>Good</th></tr></thead>
+<tbody>
+<tr><td>
+
+```go
+func foo() (x int, err error) {
+  x = 42
+  return 
+}
+```
+
+</td><td>
+
+```go
+func foo() (x int, err error) {
+  x = 42
+  return x, err
+}
+```
+
+</td></tr>
+</tbody></table>
+
 ### Use Raw String Literals to Avoid Escaping
 
 Go supports [raw string literals](https://golang.org/ref/spec#raw_string_lit),