这是一个创建于 1507 天前的主题，其中的信息可能已经有所发展或是发生改变。
最近想规范统一下组里的注释, 很多 GO 源码都有这种前缀注释
想问下这是不是有什么相关工具能生成吗?
目前查到的是利用 gocmt 作为 goland 的外部工具来生成.
还有是否会在提交代码时作一层 golint 校验规范.
想问下这是不是有什么相关工具能生成吗?
目前查到的是利用 gocmt 作为 goland 的外部工具来生成.
还有是否会在提交代码时作一层 golint 校验规范.
 |
1
Jirajine 2020-11-07 12:14:10 +08:00 via Android  4
不是生成的，是手写的。不这样写 linter 给警告。
|
 |
2
ysicing 2020-11-07 13:18:36 +08:00
手写的。有时候不知道写啥或者懒得写就...
|
 |
3
treblex 2020-11-07 13:28:12 +08:00
go 不是说官方规范风格统一的吗，有什么自定义的空间嘛
|
 |
4
hq 2020-11-07 15:08:57 +08:00
一般是手写的，能写有意义的注释还是尽量不要这样。
但有时我也感觉写的注释是无意义的，所以就这样了。 还有就是有过导入外部代码到项目的情况，为了让 golint 通过不得不再补注释，为了图方便，找到了这个神器，https://github.com/cuonglm/gocmt，慎用 |
 |
5
ppphp 2020-11-07 17:55:54 +08:00
这个不是工具生成的，是给人用的
golang 文档，代码提示之类的工具，会在 parse 代码的时候把 struct 和 func 前正上方的注释作为函数文档，package 正上方的注释作为包的文档，比如 godoc 和 golsp 就是这么工作的 |
 |
7
WhatC OP 1
@suke971219 所以想生成统一的前缀注释, 可以在省略号处加补自己的具体注释
|
 |
9
DeWhite 2020-11-07 23:10:46 +08:00
如果结构体要 拿出软件来用十来注释呀，方便人知道具体是干啥的。
|
 |
10
ooh 2020-11-08 01:56:34 +08:00
gofmt 官方统一的
|
Select Language