感动, 这位粉丝给 gws 源码几乎每一行都写了注释 !

2024-08-05 09:53:02 +08:00
 Nazz

GWS 注解版 https://github.dev/shengyanli1982/gws/tree/dev

简介

GWS 是一个用 Go 编写的非常简单、快速、可靠且功能丰富的 WebSocket 实现, 它内置了压缩上下文接管, 代理, 广播 并发限制等等一系列实用功能, 您可以轻松编写自己的服务器或客户端。

14817 次点击
所在节点    Go 编程语言
94 条回复
weakish
2024-08-05 10:30:26 +08:00
// 设置元素的值
// 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

如果不是機器輔助生成的,真是好有耐心。
有種坐飛機,同樣的內容用出發地語言、目的地語言、英文三種語言分別播報一遍的感覺。
Nazz
2024-08-05 10:34:52 +08:00
@weakish 即使有 AI 辅助, 也肯定人为校准过, 非常费心了
sleepm
2024-08-05 10:39:28 +08:00
链接是 .dev 你确定不是你自己么
jevonszmx
2024-08-05 10:41:19 +08:00
@weakish 这注释写了等于没写吧
panlatent
2024-08-05 10:43:13 +08:00
这种注释算不得好注释,不如没有,去掉后不影响我阅读代码,反而把 3 行的东西便成了这么多行,意义何在?
Nazz
2024-08-05 10:43:30 +08:00
@jevonszmx 因为一小片代码的注释就否定所有工作, 以偏概全了
Nazz
2024-08-05 10:45:02 +08:00
@sleepm 我不理解你的推理逻辑
jptx
2024-08-05 10:46:53 +08:00
@sleepm github.dev 是 github 官方的,使用 vscode 浏览代码用的,你在 GitHub 任何一个仓库页面按键盘上的 [.] 键即可打开,建议体验一下
ElmerZhang
2024-08-05 10:47:55 +08:00
具体观点我就不发表了,说出来不太好听。
herozzm
2024-08-05 10:48:11 +08:00
@panlatent 同意,就 op 发的代码来说,这些注释无意义
Nazz
2024-08-05 10:48:48 +08:00
@panlatent 哈哈, 有点过于详尽了. 如果在快速迭代阶段, 我会大片删除函数内的注释, 不过现在代码仓库主干已经非常稳定了, 应该不会再有重大更新, 接受 PR 就当表彰粉丝的热情了.
mars2023
2024-08-05 10:50:44 +08:00
@herozzm #10 不仅 op 发出来的代码;简单看了 client 的代码。
这个中英文注释还真不如没有注释,真的很影响阅读代码。
谁家的注释是这样子写的!!
deplives
2024-08-05 10:54:56 +08:00
@sleepm 魔怔了吧
lmw2616
2024-08-05 10:58:15 +08:00
用 ai 生成的吧
ryougifujino
2024-08-05 11:00:15 +08:00
泼个冷水,个人感觉这并不是什么好的做法。真正好的代码应该在简单的地方做到使用命名进行自注释,在复杂有必要的地方才进行注释。每一行都进行注释反而增加了噪声会影响阅读。
cinlen
2024-08-05 11:03:27 +08:00
```
// 返回客户端连接、HTTP 响应和错误信息
// Return the client connection, HTTP response, and error information
return client, resp, err
```

建议 revert 掉这个 pr
EchoWhale
2024-08-05 11:14:51 +08:00
这种注释没必要, 只会把仓库变成屎山, 迭代几次后, 到处都是注释和代码不一致的逻辑
ala2008
2024-08-05 11:20:37 +08:00
浪费存储和无效阅读
pkoukk
2024-08-05 11:22:32 +08:00
好的代码是能 self explain 的,注释有且只有重要的地方需要写
写在这些无关紧要的地方,你以后改代码,这里的注释改不改?
xuelu520
2024-08-05 11:24:12 +08:00
注释不是越多越好,很多无效注释还会影响阅读,建议 revert 掉这个 pr

这是一个专为移动设备优化的页面(即为了让你能够在 Google 搜索结果里秒开这个页面),如果你希望参与 V2EX 社区的讨论,你可以继续到 V2EX 上打开本讨论主题的完整版本。

https://www.v2ex.com/t/1062520

V2EX 是创意工作者们的社区,是一个分享自己正在做的有趣事物、交流想法,可以遇见新朋友甚至新机会的地方。

V2EX is a community of developers, designers and creative people.

© 2021 V2EX