Skip to content

Conversation

@gengxinMT
Copy link
Contributor

No description provided.

@shafreeck shafreeck requested review from YIDWang, shafreeck and xuehuaying and removed request for YIDWang January 9, 2019 13:30
Copy link

@xuehuaying xuehuaying left a 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

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.

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?

Copy link
Contributor

@shafreeck shafreeck Jan 11, 2019

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

@shafreeck shafreeck merged commit b4d2924 into master Jun 4, 2019
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

4 participants