mirror of
https://github.com/d0zingcat/gocryptotrader.git
synced 2026-05-29 15:10:37 +00:00
Added coding-style.md
This commit is contained in:
33
doc/coding-style.md
Normal file
33
doc/coding-style.md
Normal file
@@ -0,0 +1,33 @@
|
||||
Coding Style
|
||||
===============
|
||||
|
||||
In order to maintain a consistent style across the codebase, the following coding style has been adopted:
|
||||
|
||||
- Function names use PascalCase (func SomeFunc()).
|
||||
- Function names using acronyms are capitilised (func SendHTTPRequest()).
|
||||
- Variable names use CamelCase (var someVar()).
|
||||
- Coding style uses gofmt.
|
||||
- Const variables are capitilised.
|
||||
- In line with gofmt, for loops and if statements don't require paranthesis.
|
||||
|
||||
Block style example:
|
||||
```go
|
||||
func SendHTTPRequest(method, path string, headers map[string]string, body io.Reader) (string, error) {
|
||||
result := strings.ToUpper(method)
|
||||
|
||||
if result != "POST" && result != "GET" && result != "DELETE" {
|
||||
return "", errors.New("Invalid HTTP method specified.")
|
||||
}
|
||||
|
||||
req, err := http.NewRequest(method, path, body)
|
||||
|
||||
if err != nil {
|
||||
return "", err
|
||||
}
|
||||
|
||||
for k, v := range headers {
|
||||
req.Header.Add(k, v)
|
||||
}
|
||||
...
|
||||
}
|
||||
```
|
||||
Reference in New Issue
Block a user