未分類
2020 年 11 月 11 日

一些 GO 的代码注释与规范问题

一些 GO 的代码注释与规范问题

資深大佬 : WhatC 1

最近想规范统一下组里的注释, 很多 GO 源码都有这种前缀注释

一些 GO 的代码注释与规范问题

想问下这是不是有什么相关工具能生成吗?
目前查到的是利用 gocmt 作为 goland 的外部工具来生成.

还有是否会在提交代码时作一层 golint 校验规范.

大佬有話說 (10)

  • 資深大佬 : Jirajine

    不是生成的，是手写的。不这样写 linter 给警告。

  • 資深大佬 : ysicing

    手写的。有时候不知道写啥或者懒得写就…

  • 資深大佬 : suke971219

    go 不是说官方规范风格统一的吗，有什么自定义的空间嘛

  • 資深大佬 : hq

    一般是手写的，能写有意义的注释还是尽量不要这样。
    但有时我也感觉写的注释是无意义的，所以就这样了。
    还有就是有过导入外部代码到项目的情况，为了让 golint 通过不得不再补注释，为了图方便，找到了这个神器，https://github.com/cuonglm/gocmt，慎用

  • 資深大佬 : ppphp

    这个不是工具生成的，是给人用的
    golang 文档，代码提示之类的工具，会在 parse 代码的时候把 struct 和 func 前正上方的注释作为函数文档，package 正上方的注释作为包的文档，比如 godoc 和 golsp 就是这么工作的

  • 主 資深大佬 : WhatC

    @hq 主要是想用 gocmt 先生成 // FuncName …这种类型, 后面肯定是有自己的具体注释

  • 主 資深大佬 : WhatC

    @suke971219 所以想生成统一的前缀注释, 可以在省略号处加补自己的具体注释

  • 主 資深大佬 : WhatC

    @ppphp godoc 了解.
    看到很多源码都是这种风格, 想学习下代码外的规范

  • 資深大佬 : DeWhite

    如果结构体要 拿出软件来用十来注释呀，方便人知道具体是干啥的。

  • 資深大佬 : ooh

    gofmt 官方统一的