一些 GO 的代码注释与规范问题 - V2EX
V2EX = way to explore
V2EX 是一个关于分享和探索的地方
Sign Up Now
For Existing Member  Sign In
The Go Programming Language
http://golang.org/
Go Playground
Go Projects
Revel Web Framework
WhatC

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

  •  
  •   WhatC Nov 7, 2020 3940 views
    This topic created in 1999 days ago, the information mentioned may be changed or developed.
    最近想规范统一下组里的注释, 很多 GO 源码都有这种前缀注释



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

    还有是否会在提交代码时作一层 golint 校验规范.
    10 replies    2020-11-08 01:56:34 +08:00
    Jirajine
        1
    Jirajine  
       Nov 7, 2020 via Android   4
    不是生成的,是手写的。不这样写 linter 给警告。
    ysicing
        2
    ysicing  
       Nov 7, 2020
    手写的。有时候不知道写啥或者懒得写就...
    treblex
        3
    treblex  
       Nov 7, 2020
    go 不是说官方规范风格统一的吗,有什么自定义的空间嘛
    hq
        4
    hq  
       Nov 7, 2020
    一般是手写的,能写有意义的注释还是尽量不要这样。
    但有时我也感觉写的注释是无意义的,所以就这样了。
    还有就是有过导入外部代码到项目的情况,为了让 golint 通过不得不再补注释,为了图方便,找到了这个神器,https://github.com/cuonglm/gocmt,慎用
    ppphp
        5
    ppphp  
       Nov 7, 2020
    这个不是工具生成的,是给人用的
    golang 文档,代码提示之类的工具,会在 parse 代码的时候把 struct 和 func 前正上方的注释作为函数文档,package 正上方的注释作为包的文档,比如 godoc 和 golsp 就是这么工作的
    WhatC
        6
    WhatC  
    OP
       Nov 7, 2020
    @hq 主要是想用 gocmt 先生成 // FuncName ...这种类型, 后面肯定是有自己的具体注释
    WhatC
        7
    WhatC  
    OP
       Nov 7, 2020   1
    @suke971219 所以想生成统一的前缀注释, 可以在省略号处加补自己的具体注释
    WhatC
        8
    WhatC  
    OP
       Nov 7, 2020
    @ppphp godoc 了解.
    看到很多源码都是这种风格, 想学习下代码外的规范
    DeWhite
        9
    DeWhite  
       Nov 7, 2020
    如果结构体要 拿出软件来用十来注释呀,方便人知道具体是干啥的。
    ooh
        10
    ooh  
       Nov 8, 2020
    gofmt 官方统一的
    About     Help     Advertise     Blog     API     FAQ     Solana     3131 Online   Highest 6679       Select Language
    创意工作者们的社区
    World is powered by solitude
    VERSION: 3.9.8.5 44ms UTC 14:17 PVG 22:17 LAX 07:17 JFK 10:17
    Do have faith in what you're doing.
    ubao msn snddm index pchome yahoo rakuten mypaper meadowduck bidyahoo youbao zxmzxm asda bnvcg cvbfg dfscv mmhjk xxddc yybgb zznbn ccubao uaitu acv GXCV ET GDG YH FG BCVB FJFH CBRE CBC GDG ET54 WRWR RWER WREW WRWER RWER SDG EW SF DSFSF fbbs ubao fhd dfg ewr dg df ewwr ewwr et ruyut utut dfg fgd gdfgt etg dfgt dfgd ert4 gd fgg wr 235 wer3 we vsdf sdf gdf ert xcv sdf rwer hfd dfg cvb rwf afb dfh jgh bmn lgh rty gfds cxv xcv xcs vdas fdf fgd cv sdf tert sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf sdf shasha9178 shasha9178 shasha9178 shasha9178 shasha9178 liflif2 liflif2 liflif2 liflif2 liflif2 liblib3 liblib3 liblib3 liblib3 liblib3 zhazha444 zhazha444 zhazha444 zhazha444 zhazha444 dende5 dende denden denden2 denden21 fenfen9 fenf619 fen619 fenfe9 fe619 sdf sdf sdf sdf sdf zhazh90 zhazh0 zhaa50 zha90 zh590 zho zhoz zhozh zhozho zhozho2 lislis lls95 lili95 lils5 liss9 sdf0ty987 sdft876 sdft9876 sdf09876 sd0t9876 sdf0ty98 sdf0976 sdf0ty986 sdf0ty96 sdf0t76 sdf0876 df0ty98 sf0t876 sd0ty76 sdy76 sdf76 sdf0t76 sdf0ty9 sdf0ty98 sdf0ty987 sdf0ty98 sdf6676 sdf876 sd876 sd876 sdf6 sdf6 sdf9876 sdf0t sdf06 sdf0ty9776 sdf0ty9776 sdf0ty76 sdf8876 sdf0t sd6 sdf06 s688876 sd688 sdf86