mirror of
https://github.com/lightningnetwork/lnd.git
synced 2025-07-08 06:20:25 +02:00
docs: add guidelines for func declarations [skip ci]
This commit is contained in:
@ -485,8 +485,34 @@ statements and select statements.
|
|||||||
```
|
```
|
||||||
|
|
||||||
If one is forced to wrap lines of function arguments that exceed the 80
|
If one is forced to wrap lines of function arguments that exceed the 80
|
||||||
character limit, then a new line should be inserted before the first stanza in
|
character limit, then identation must be kept on the following lines. Also,
|
||||||
the comment body.
|
lines should not end with an open open parenthesis.
|
||||||
|
|
||||||
|
**WRONG**
|
||||||
|
```go
|
||||||
|
func foo(a, b, c,
|
||||||
|
) (d, error) {
|
||||||
|
|
||||||
|
func bar(a, b, c) (
|
||||||
|
d, error,
|
||||||
|
) {
|
||||||
|
|
||||||
|
func baz(a, b, c) (
|
||||||
|
d, error) {
|
||||||
|
```
|
||||||
|
**RIGHT**
|
||||||
|
```go
|
||||||
|
func foo(a, b,
|
||||||
|
c) (d, error) {
|
||||||
|
|
||||||
|
|
||||||
|
|
||||||
|
func baz(a, b, c) (d,
|
||||||
|
error) {
|
||||||
|
```
|
||||||
|
|
||||||
|
If a function declaration spans multiple lines the body should start with an
|
||||||
|
empty line.
|
||||||
|
|
||||||
**WRONG**
|
**WRONG**
|
||||||
```go
|
```go
|
||||||
|
Reference in New Issue
Block a user