-
Notifications
You must be signed in to change notification settings - Fork 2
translate to english #22
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Conversation
xuehuaying
left a comment
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
It seems that I have modified almost all comments in the review but the problems do not differ too much. Some of them need to be double checked by yourselves to see if my comprehension is right or not.
| ) | ||
|
|
||
| var ( | ||
| // ErrNotFound no found error |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
ls there any need to add this comment? If any, no more information could be achieved from this comment. My suggestion is to delete this comment for the code is quite clear here.
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
But still is it necessary to add this comment?
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
@xuehuaying
It is the gopher's best practice to comment on the exported functions or variables. The comments will be collected by godoc to generate an API document like https://godoc.org/github.com/tipsio/tips.
There is an article for this https://blog.golang.org/godoc-documenting-go-code
No description provided.