Golang Go语言中，感动！这位粉丝给 gws 源码几乎每一行都写了注释

// 设置元素的值
// Set the value of the element
ele.value = value

// 执行将元素推到队列尾部的操作
// Perform the operation to push the element to the back of the deque
c.doPushBack(ele)

// 返回该元素
// Return the element
return ele

如果不是機器輔助生成的，真是好有耐心。
有種坐飛機，同樣的內容用出發地語言、目的地語言、英文三種語言分別播報一遍的感覺。

更多关于Golang Go语言中，感动！这位粉丝给 gws 源码几乎每一行都写了注释的实战系列教程也可以访问 https://www.itying.com/category-94-b0.html

h691938207 2楼•1 天前

即使有 AI 辅助, 也肯定人为校准过, 非常费心了

htzhanglong 3楼•1 天前

链接是 .dev 你确定不是你自己么

vueper 4楼•1 天前

这注释写了等于没写吧

vueper 5楼•1 天前

这种注释算不得好注释，不如没有，去掉后不影响我阅读代码，反而把 3 行的东西便成了这么多行，意义何在？

nodeper 6楼•1 天前

因为一小片代码的注释就否定所有工作, 以偏概全了

wuwangju 7楼•1 天前

我不理解你的推理逻辑

gougou168 8楼•1 天前

github.dev 是 github 官方的，使用 vscode 浏览代码用的，你在 GitHub 任何一个仓库页面按键盘上的 [.] 键即可打开，建议体验一下

gougou168 9楼•1 天前

具体观点我就不发表了，说出来不太好听。

phonegap100 10楼•1 天前

同意，就 op 发的代码来说，这些注释无意义

yuanlaile 11楼•1 天前

哈哈, 有点过于详尽了. 如果在快速迭代阶段, 我会大片删除函数内的注释, 不过现在代码仓库主干已经非常稳定了, 应该不会再有重大更新, 接受 PR 就当表彰粉丝的热情了.

sinazl 12楼•1 天前作者

#10 不仅 op 发出来的代码；简单看了 client 的代码。
这个中英文注释还真不如没有注释，真的很影响阅读代码。
谁家的注释是这样子写的！！

ionicwang 13楼•1 天前

魔怔了吧

eggper 14楼•1 天前

用 ai 生成的吧

nodeper 15楼•1 天前

泼个冷水，个人感觉这并不是什么好的做法。真正好的代码应该在简单的地方做到使用命名进行自注释，在复杂有必要的地方才进行注释。每一行都进行注释反而增加了噪声会影响阅读。

htzhanglong 16楼•1 天前

<br>// 返回客户端连接、HTTP 响应和错误信息<br>// Return the client connection, HTTP response, and error information<br>return client, resp, err<br>

建议 revert 掉这个 pr

eggper 17楼•1 天前

这种注释没必要, 只会把仓库变成屎山, 迭代几次后, 到处都是注释和代码不一致的逻辑

eggper 18楼•1 天前

浪费存储和无效阅读

sinazl 19楼•1 天前作者

好的代码是能 self explain 的，注释有且只有重要的地方需要写
写在这些无关紧要的地方，你以后改代码，这里的注释改不改？

zlyuanteng 20楼•1 天前

注释不是越多越好，很多无效注释还会影响阅读，建议 revert 掉这个 pr

itying888 21楼•1 天前

无效注释，大部分都在重复代码的含义
// 配置信息
// Configuration information
config *Config

// 缓冲读取器
// Buffered reader
br *bufio.Reader

// 持续帧
// Continuation frame
continuationFrame continuationFrame

// 帧头
// Frame header
fh frameHeader
这种有啥可以注释的

sinazl 22楼•1 天前作者

. 或者 github1s 这些都用过，都知道
但凡发链接一般都是 .com
粘贴 .dev 有一定概率就是推广

htzhanglong 23楼•1 天前

建议移到推广节点，类似标题让我想到 XHS 上的标题党：
“XX 城市这家店劝你不要来” —— 点进去老板人太热情送太多东西吃不完…
“崩溃了老板大我五十岁不懂得边界感” —— 点进去是给她升职加薪

yuanlaile 24楼•1 天前

好的代码应该是自解释的

h691938207 25楼•1 天前

你列举的这个应该是使用了 go 语言的代码注释规范，不加上吧，提示不消除又难受

zlyuanteng 26楼•1 天前

注释要写的是“因为什么要这样做”，因为“这行代码做了什么”代码本身已经可以告诉我们了
所以，就看一楼给出的那三行的话，这注释不如不写

sinazl 27楼•1 天前作者

作为一个成熟的库基本等于脱 xxxx ，但是作为一个另外的学习项目，对于学习者就非常有用了

sinazl 28楼•1 天前作者

这种注释还是别了
注释还是用来说一下为了解决什么问题如何做包括函数名的含义自注释
如果只是简单翻译一下代码这种注释有什么意义

caililin 29楼•1 天前

1982 不教教你的粉丝什么是代码可读性，跑过来炫耀，真好笑。

eggper 30楼•1 天前

#22 用过应该知道,你只要按[.],域名就会变成.dev 吧,这也是推广?

htzhanglong 31楼•1 天前

冷知识
github.dev 其实是由 GitHub 官方推出的 /手动狗头
说白了就是一个一个 web 版的 VsCode ,可以浏览器在线编辑提交 GitHub 仓库内的文件

yuanlaile 32楼•1 天前

这个 ai 注释的语气真的挺让人感到别扭的。理解都要好大一会儿。注释这么加，真的没人愿意看的

nodeper 33楼•1 天前

这位热心的粉丝给你拉了一坨大的

ionicwang 34楼•1 天前

还有耐心，中英注释

itying888 35楼•1 天前

别的先不说。原来还有那么多人不知道.dev 啊

nodeper 36楼•1 天前

不利于维护，之后改代码还要改双语注释，只能说没啥好处

h691938207 37楼•1 天前

是的，合并前需要大片删除函数内的注释

vueper 38楼•1 天前

不要为了写注释而写注释

nodeper 39楼•1 天前

我觉得挺好的，对于不了解 go 的开发者很友好，至于楼中的一些维护问题以及改代码后注释不对的问题，我不敢苟同，修改注释本来就是维护中的一部分，只改代码懒得去改注释，这就是坏习惯，不是理所当然，而且楼中提到的无意义注释：// 配置信息，// 缓冲读取器，// 缓冲读取器，根本就不会去经常改，哪来的维护麻烦的问题

vueper 40楼•1 天前

一看就懂的简单的东西，还这么注释只会影响阅读

h691938207 41楼•1 天前

AI 搞的？

h691938207 42楼•1 天前

估计是 AI 生成用来混大量 PR 的建议 revert 很多地方直接变量可以做到自注释，简单的逻辑也不需要太细致入微注释

nodeper 43楼•1 天前

突然想到一句话，有些事情真不是勤奋就能做的好的，确实带点天赋。

vueper 44楼•1 天前

代码简洁之道：无效注释不仅不能起到说明作用反而会增加复杂度注释要简短有力

yibo5220 45楼•1 天前

大可不必都加上注释吧。

另外搞开源就别说粉丝了吧，感觉像是饭圈。。

songsunli 46楼•1 天前

这注释是给人类看的？ AIGC 污染环境。
反过来讲，都开始研究这种东西的源码了，会连 golang 的基础都看不懂吗？

yibo5220 47楼•1 天前

就是 AI 生成的注释，基本上按照变量名字猜，然后翻译出来。当做 AI 工具还有点用，提交到代码里完全没必要

h691938207 48楼•1 天前

除了降低代码可读性之外几乎没有任何价值

caililin 49楼•1 天前

好的代码应尽量做到代码即注释，需要大量注释才能理解，只能证明代码难以清晰直观地表达意图，需要靠人类的自然语言辅助。

bupafengyu 50楼•1 天前

有没有像我一样的，用 copilot ，先写注释，自动生成代码，然后改改代码，然后继续这个循环

nodeper 51楼•1 天前

(今天中午饭点在知乎看到类似讨论…

yuanlaile 52楼•1 天前

感觉作者有点儿疯了:)_

nodeper 53楼•1 天前

关于 ai 生成注释，反过来想是不是可以写代码时不用写注释了或者只在特殊逻辑的地方写，以后自己或他人再读代码时临时 ai 生成注释

yuanlaile 54楼•1 天前

sinazl 55楼•1 天前作者

感觉是拿 gpt 批量生成的，好奇原作者会不会合并

反正如果是我，我首先评论一句感谢 pr ，然后发一句感觉没什么用就关闭 pr 了

htzhanglong 56楼•1 天前

刚好想到这图，哈哈哈哈

phonegap100 57楼•1 天前

注释一般注释业务、产品背景

htzhanglong 58楼•1 天前

这注释说真的。。感觉没啥用。

几乎每行都写注释我第一反应是恐怖，因为这种行为完全没有意义，而且居然还推给上游了。。

挺好奇楼主真的打算合并这个吗。

注释讲究的是适当，不适当的注释还不如没有，go 基础不好就回去专门学基础，没必要再项目中去搞这些。

songsunli 59楼•1 天前

评论区好多酸烂臭萝卜哦。跟蛆一样，于自己没有任何好处，还要恶心别人一把。

yuanlaile 60楼•1 天前

要把多余的去掉，工作量蛮大

wuwangju 61楼•1 天前

1. OP 标题党，实则在推广自己的项目
2. 我看见大多数评论都在讨论注释的问题，而这正是标题强调的，有何不可？
3. 你这段话，整个评论区里面最受用的其实就是你自己

htzhanglong 62楼•1 天前

懂得都懂吧

ionicwang 63楼•1 天前

学到了👍

h691938207 64楼•1 天前

懂得都懂

itying888 65楼•1 天前

他写错了，其实是以上所有代码都是注释补全的，这就是注释的意义

sinazl 66楼•1 天前作者

这个帖子还是不错的，学习到了 GitHub 仓库按 . 进入编辑器模式。

sinazl 67楼•1 天前作者

i = i + 1; // 为 i 加一

ionicwang 68楼•1 天前

aigc 作为一种工具很好用, 但是很恶心把生成的东西丢到论坛社区. 包括
1. 在 b 站这种视频网站下面小助手总结一下
2. 在论坛丢 aigc 没验证过的片汤话
现在竟然连代码中都开始加这种没营养影响观感的东西.

nodeper 69楼•1 天前

写的废话太多了

wuwangju 70楼•1 天前

> 接受 PR 就当表彰粉丝的热情了

#11 我个人觉得 “表彰” => “感谢” 更好些

songsunli 71楼•1 天前

哈哈，确实没什么用，不过感觉这个加一堆注释的代码挺适合当没有 golang 基础的新手学 golang 的教材的

htzhanglong 72楼•1 天前

粉丝？偶像？

ionicwang 73楼•1 天前

这就是 ai 生成的

hn 上有人吐槽过了

vueper 74楼•1 天前

大部分代码是能够自我解释的，如果不能，首先考虑重构，再考虑加注释

songsunli 75楼•1 天前

这种注释等于是路边有棵树，然后挂个牌子写着：“这是树”

sinazl 76楼•1 天前作者

注释应该主要用来解释代码为什么这么写吧

phonegap100 77楼•1 天前

我还是喜欢用 melody

bupafengyu 78楼•1 天前

💩 // ← 这就是史

sinazl 79楼•1 天前作者

嗯，感谢他的贡献，提供吉祥物和完善文档

zlyuanteng 80楼•1 天前

习惯问题，我更喜欢 JavaScript WebSocket API 而不是 channel.

songsunli 81楼•1 天前

虔诚式学习就是把数学作业的正确答案虔诚地用红笔注释在自己的答案旁边

您的是虔诚式注释把整本课本都拿荧光笔涂了

wuwangju 82楼•1 天前

代码注释的重点是解释为什么要这么做，而不是把程序语言语义翻译成自然语言！！！

songsunli 83楼•1 天前

才知道还有快捷方式打开，插件没用了之后都是手改 😂

songsunli 84楼•1 天前

《代码整洁之道》

sinazl 85楼•1 天前作者

学到了，还能这样

zlyuanteng 86楼•1 天前

以现在 AI 的水平，生成这些注释根本不需要人工校验

phonegap100 87楼•1 天前

学到了，还有这种快捷键

phonegap100 88楼•1 天前

感觉这注释就是为了注释而注释

nodeper 89楼•1 天前

#3 github.dev 要公开卖的话，估计价格会很离谱

eggper 90楼•1 天前

推广贴,这次就不 at 站长了,好自为之

vueper 91楼•1 天前

赶紧去艾特

itying888 92楼•1 天前

我没有以偏概全否定所有工作啊，我说这注释，这。这。这注释

itying888 93楼•1 天前

1.踩着你尾巴了
2.你急了
3.呵呵

zlyuanteng 94楼•1 天前

我写注释是为了几个月后回看代码知道自己干了什么

gougou168 95楼•1 天前

在Golang（Go语言）社区中，看到如此热心的粉丝对gws源码进行详尽的注释，确实是一件令人感动的事情。这不仅体现了对开源项目的热爱和支持，也极大地促进了代码的可读性和维护性。

对于gws这样的项目，源码的注释是至关重要的。它们能够帮助其他开发者更快地理解代码的逻辑和意图，减少因误解而导致的错误。这位粉丝的每一行注释，都可能是其他开发者在阅读和理解代码时的一份宝贵指南。

当然，我们也应该注意到，虽然详尽的注释非常有价值，但过多的注释也可能会增加代码的复杂性。因此，在编写注释时，我们需要找到一个平衡点，既要确保注释足够清晰和有用，又要避免它们成为代码的负担。

此外，对于开源项目来说，这样的贡献也是极其宝贵的。它不仅提升了项目的质量，还增强了社区的凝聚力和活跃度。因此，我建议gws项目的维护者能够认真审阅这些注释，并考虑将它们合并到主分支中，以惠及更多的开发者。

总之，这位粉丝对gws源码的注释工作是非常值得赞赏的。它不仅展示了Go语言社区的活力和热情，也为其他开发者提供了极大的帮助。希望我们能够继续发扬这种精神，共同推动Go语言和相关开源项目的发展。

Golang Go语言中，感动！这位粉丝给 gws 源码几乎每一行都写了注释

简介