exported function xxx should have comment or be unexported。

exported function xxx should have comment or be unexported

0x01 解决

https://golang.org/s/style 在这个页面中有提到

Comment SentencesSee https://golang.org/doc/effective_go.html#commentary. Comments documenting declarations should be full sentences, even if that seems a little redundant. This approach makes them format well when extracted into godoc documentation. Comments should begin with the name of the thing being described and end in a period:

记录声明的注释应该是完整的句子,即使这看起来有点多余。这种方法使它们在提取到 godoc 文档时格式良好。注释应以所述物品的名称开始,并以句号结束:

// Request represents a request to run a command.
type Request struct { ...
// Encode writes the JSON encoding of req to w.
func Encode(w io.Writer, req *Request) { ...

正是如此,golint 才会抛出这条警告,声明你写的代码不符合规范。

符合规范的修改:

exported function xxx should have comment or be unexported

在方法调用中,能看到注释信息:

exported function xxx should have comment or be unexported

相关文章:

  • 2022-12-23
  • 2021-07-08
  • 2021-11-18
  • 2021-08-18
  • 2022-12-23
  • 2021-09-10
  • 2021-04-11
  • 2022-12-23
猜你喜欢
  • 2022-12-23
  • 2022-12-23
  • 2022-12-23
  • 2022-12-23
  • 2021-07-29
  • 2021-10-16
  • 2021-08-29
相关资源
相似解决方案