20 lines
942 B
Markdown
20 lines
942 B
Markdown
|
# Hints
|
||
|
|
|
||
|
|
## General
|
||
|
|
|
||
|
|
- A [documentation comment][comment] should be written directly before the entity that it is describing, start with the name of what it is describing, take the form of a sentence, and end with a period.
|
||
|
|
|
||
|
|
## 1. Document package weather
|
||
|
|
|
||
|
|
- The [package comment][comment] should be written directly before the package, start with `Package x`, and end with a period.
|
||
|
|
|
||
|
|
## 2. Document the CurrentCondition and CurrentLocation variables
|
||
|
|
|
||
|
|
- The [variable comment][variable comment] should be written right before the variable that it is describing, start with its name, and end with a period.
|
||
|
|
|
||
|
|
## 3. Document the Forecast() function
|
||
|
|
|
||
|
|
- The [function comment][comment] should come directly before the function, start with the name of the function and end with a period.
|
||
|
|
|
||
|
|
[comment]: https://golang.org/doc/effective_go.html#commentary
|
||
|
|
[variable comment]: https://dave.cheney.net/practical-go/presentations/qcon-china.html#_comments
|