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

[Nazz]

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

简介

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

[sworld233]

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

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

// 持续帧
// Continuation frame
continuationFrame continuationFrame

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

[sleepm]

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

[uSy62nMkdH]

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

[netizenHan]

好的代码应该是自解释的

[ohoh]

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

[boris1993Jr]

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

[fregie]

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

[www5070504]

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

[greycell]

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

[AlvaMu]

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

[gcod]

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

[oeyoews]

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

[humingk]

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

[allenby]

还有耐心，中英注释

[honjow]

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

[liquid207]

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

[Nazz]

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

[huyiwei]

不要为了写注释而写注释

[maymay5]

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

[SuperNPC]

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