首页 > V2EX > V2EX-老板,别再让打工人写文档和注释了
2022
01-13

V2EX-老板,别再让打工人写文档和注释了

leontung:

害,我真是忍不住了,要 Code Review 我能理解(已经在求助大家有没有提效的方案了),但还要求写注释和文档,说是为了方便知识共享和新人入职。
WTF ?也不看看我们的业绩压力,万一不巧被裁下个月就去喝西北风了,新人关我 P 事。

索性吐槽一下看看大家想法:

  1. 我经历过小中大厂,经历的大部分代码是没有注释的,某些写得像屎山的代码,看起来十分费劲,重构不好还要挨刀子背锅,被骂出 bug
  2. 我花力气看懂了,好心写了注释,好像也没人关心?老板也不怎么来 code review ,都是同事之间+1 和 LGTM ,感觉我吃力不讨好
  3. 我发现其他人写的 bug ,我都是飞书告诉他要修掉或者我自己默默修掉了,如果我再和老板说 xxx 的代码有问题,感觉有点像背后捅一刀?给老板感觉也不好,为了鸡毛蒜皮的事情邀功?
  4. 之前在一家外企用那破 Confluence 让我抓狂,现在公司用飞书文档体验好了,但维护起来麻烦啊,代码更新了 Readme 和文档也要更新

年底了,就问问大家,大家写文档和注释有年终奖不?(逃…

正经时间:

其实我打心底觉得写文档和注释是个好习惯,毕竟咱们是靠代码吃饭的,但在公司内部有业绩压力有时候是心有余力不足,况且好多时候工具和代码是割裂的。
因此我正在写一个 VSCode 的插件,做一款基于代码的协作和知识分享,而不是现在基于文档( README 、飞书等)。
就目前而言,我希望先实现:

  1. 在代码仓库里写注释的时候,如果看到有价值的信息,可以在 IDE 里同步到飞书文档 /Github 的 Readme 里等(这块还在想)
  2. IDE 里顺手创建一个 Github/Gitlab issue ,再分配给我的同事(这个已经在做)
  3. 同步消息到飞书群 /钉钉群大家都能看到,显得我中立一点不要像是个打小报和为了这件事打报告的人
    老板,咱们有锅背锅,有功拿奖行不行。

不知道大家是否感兴趣?如果感兴趣的话留个联系方式,等我开发完之后发给大家做 beta 测试。也可以给我提点意见。

真是难为我这个写 Golang 的后端,每天下班后啃前端代码(不说了,去写了…

附带效果:
选择代码块
V2EX-老板,别再让打工人写文档和注释了 - 第1张  | 牛C网(NiuL.Net)
在插件上写个标题就能创建一个 Github Issue
V2EX-老板,别再让打工人写文档和注释了 - 第2张  | 牛C网(NiuL.Net)

from V2EX-最新主题 https://ift.tt/3ffVrP9
V2EX-老板,别再让打工人写文档和注释了 - 第3张  | 牛C网(NiuL.Net)
牛C网:https://j1o.net
牛C网导航:https://niuc.icu
零九导航:https://09.gay

最后编辑:
作者:分享菌
这个作者貌似有点懒,什么都没有留下。

留下一个回复

你的email不会被公开。