每一个认认真真写文档的程序猿都会被无良 HR 逼成不写注释的屑码农

V2EX = way to explore

V2EX 是一个关于分享和探索的地方

现在注册

已注册用户请登录

这是一个创建于 1570 天前的主题，其中的信息可能已经有所发展或是发生改变。

最近离职交接工作, 上一个公司负责的项目有一个我长期维护的文档库, 每一个组件每一个 API 都有对应的文档, 写清楚起什么作用为什么这么设置要如何启动, 还配了一大堆图, 部分比较麻烦的库我还把自己的笔记也粘贴了上去了生怕别人看不懂, 维护的代码也有 GOOGLE 风格的大段注释, 生怕别人看不懂还按照 PEP8 修正了早期不合格的代码, 文档库光我自己的 commit 就有 3000 多个.

结果, 离职了之后 HR 找了个实习生接手项目, 我把文档给他之后, 他又烦了我几天, 天天问文档上都有的问题, 最后终于发现那个文档就是按照教傻子的标准教他们的, 老老实实按照文档来做一个礼拜就上手了.

然后同事跟我说, 那个 HR 现在天天在老板面前吹, 他招了个 4K 的实习生就完美替代掉我这个 2W 的主工程师了, 给自己头上贴小红花...

以后再写文档我就是傻逼, 提交的代码里别想看到一行注释, 总之这个项目离了我就瘫痪, 离职交接后再咨询另算钱.

文档

注释

离职

代码

85 条回复 • 2020-08-17 17:19:00 +08:00

leimao

2020-08-15 06:45:03 +08:00

HR 不得干政

green15

2020-08-15 06:51:23 +08:00 via iPhone

当做写注释文档帮自己梳理思路

levelworm

2020-08-15 07:01:01 +08:00 via Android

写注释主要是给自己的。。。其他无所谓了

levelworm

2020-08-15 07:01:53 +08:00 via Android

另外这事情楼主领导没有和老板解释么？那也不值得留恋了。

neighbads

2020-08-15 07:18:27 +08:00 via Android

早该有这觉悟的

之前有个老哥发帖说职场上应该有点私心，被喷成 go 。。。

daozhihun

2020-08-15 07:26:31 +08:00 via Android

不用在意啦，路遥知马力，新人水平怎样，以后总会体现的

laike9m

2020-08-15 07:30:12 +08:00 via Android

写文档是好习惯，被坑不是你的问题，而是公司管理的问题。你应该去一家注重代码质量和可维护性的公司。正所谓物以类聚，人也只有在合适的地方才能发挥价值。

djs

2020-08-15 07:48:09 +08:00 via iPhone

很多公司都这样，我们公司，你解决了什么疑难杂症也没见的领导觉得你咋样，写文档也不会对你有加分

lights

2020-08-15 08:10:46 +08:00 via iPhone

文档是写给 leader 看的

jorneyr

2020-08-15 08:13:03 +08:00

但行好事，莫问前程

HENQIGUAI

2020-08-15 08:18:07 +08:00

勿偏激

opengps

2020-08-15 08:19:14 +08:00

工作终究只是工作，很多时候不适合掺杂情怀，所以我把自己想写的东西放在业余

Foxkeh

2020-08-15 08:32:13 +08:00

上家公司 HR 得瑟, 然后你要去祸害下家吗? 这样不好吧哈哈哈哈.

dustinth

2020-08-15 08:36:24 +08:00

LZ 心态不行, 零和思维.

matrix67

2020-08-15 08:45:07 +08:00

文档写的好，总会占到便宜的。不用急。

SJ2050cn

2020-08-15 08:52:45 +08:00

你这让我想起了一个笑话。代码写的完美的人，每个人都看得懂，看起来谁都可以替代的，而那些代码写的一团糟的，每天风风火火改 bug，关键谁都看不懂他写的，反而成为无可替代的人。

murmur

2020-08-15 08:56:50 +08:00

我把文档给他之后, 他又烦了我几天, 天天问文档上都有的问题,

这就是你的不对了，离职之后就得付费咨询，哪里有离职了还帮着擦屁股的

gimp

2020-08-15 08:59:06 +08:00

交接文档我会整理的很仔细，要走的时候，就算是 shi 山，也要给后人留条路。

gimp

2020-08-15 09:00:55 +08:00

特别是现场的问题，一些解决问题的黑科技思路，不注明两个月后自己都会忘，做好记录总归是利人利己。

wctml

2020-08-15 09:02:01 +08:00

写自己需要的文档就行，不要为了照顾别人而写。写了接手的人也会来问你。

Mindjet

2020-08-15 09:04:01 +08:00

@gimp #19

同意(o´ω`o)و

谁也会不爽，但当务之急是更理性点，防止后续的操作有问题。

骂前东家可能不太好，尤其是让新老板知道

写文档对自己好处可能更大，权衡下来还是写比较划算

过一段时间他们的牛皮可能就会吹破了，时间站在楼主这边

JamesR

2020-08-15 11:10:22 +08:00

4K 的实习生不可能替代 2W 主工程师，主要是软件开发后期没啥工作了，再来重大新功能，肯定做不了，楼主把注意力放到提升自身技术和跳槽上即可，只有打算在一家公司养老，才能不写（公开）文档。

faceRollingKB

2020-08-15 11:12:46 +08:00

我觉得无所谓，我离职的时候也会好好整理下文档，主要目的是让后面的人快点上手我好走人，其他事情我不关心

Jirajine

2020-08-15 11:16:45 +08:00 via Android

说的好，抓紧修炼吧
https://coderlmn.github.io/frontEndCourse/unmaintainable.html

leafre

2020-08-15 11:20:40 +08:00

哪来的时间写注释

zhongjun96

2020-08-15 11:23:10 +08:00

我公司行政，把我们老员工高级的椅子都收走了，说领导坐高级的。

ruike007

2020-08-15 11:23:12 +08:00

有这样的环境，留着无用

shellus

2020-08-15 11:34:24 +08:00

每一个程序员在他的职业生涯中某一天都会突然获得开示，这种开示在通常某一个夜晚悄然降临，有时是以图灵本人托梦的形式出现。这一开示的主要内容如下：程序员是真正理解思维和逻辑真谛的人。非程序员是被蒙蔽的无知者。每一个程序员对于世界上其他程序员有着不可推卸的责任。每一个程序员都必须尽力维护程序员这一高贵种族的延续，并保证世界的命运控制在程序员手中，既不被无知者淹没，也不被机器智能取代。完成这一使命的唯一方式，是保证稳定地出产低质量，难以理解，修改和维护的代码。每一个负责任的程序员，他每一年的产出，必须为另外三个程序员制造一年的就业机会。唯此，程序员一族可生生不息，整个 IT 行业欣欣向荣。图灵大神在冥冥中微笑，他的纸带机将嗒嗒作响，直至永恒。

hoyixi

2020-08-15 11:41:14 +08:00

会干的不如会吹的，逆淘汰环境就这样。

lz 适合去外企，找机会跳吧

AlohaV2

2020-08-15 12:14:26 +08:00 via iPhone

怎么说呢，以后注释里写个比特币链接吧，打款给说明文档

across

2020-08-15 12:18:34 +08:00 via iPhone

我就想知道 ph 那个 offer 你接下了没....

vanxy

2020-08-15 12:51:40 +08:00

反过来想，你的文档完善得能让实习生都能快速上手。多棒呀。

puzzle9

2020-08-15 12:55:15 +08:00

工资好高我好羡慕

注释这事吧能力在你之上或者同级不需要写注释
在之下吧写注释也会问你

levelworm

2020-08-15 12:55:39 +08:00 via Android

@shellus 牛逼，写的不错

puzzle9

2020-08-15 12:56:16 +08:00

@Jirajine 刺激啊不过这样自己不好改应该整一个类似于 webpack 的玩意自己是源码运行是压缩后的

mywaiting

2020-08-15 13:10:21 +08:00

但行好事，莫问前程；前路有光，初心莫忘

Jirajine

2020-08-15 13:23:09 +08:00 via Android

@puzzle9 naive 啊，这里面只有少部分变量起名部分可以用 webpack 实现的，而且太明显了。
绝大部份都是整个程序的设计、架构、方法论、技巧方面的内容，比如我最喜欢这条：
>让我们从一条可能是有史以来最友好的技巧开始：把代码编译成可执行文件。如果它能用，就在源代码里做一两个微小的改动 -- 每个模块都照此办理。但是不要费劲巴拉地再编译一次了。你可以留着等以后有空而且需要调试的时候再说。多年以后，等可怜的维护代码的程序员更改了代码之后发现出错了，他会有一种错觉，觉得这些肯定是他自己最近修改的。这样你就能让他毫无头绪地忙碌很长时间。
所以还是要靠自己修炼，依赖外部工具是不行的。

puzzle9

2020-08-15 13:33:24 +08:00

@Jirajine 我突然觉得这样做有点狠而且在国内容易吃官司不过还有另一个方法就是用新技术一个新的技术栈

loliordie

2020-08-15 13:46:21 +08:00

@across 接了啊, 这不是正在离职交接么. 打算两个工作中间的 gap 开车出去玩玩

sanxianA

2020-08-15 14:17:01 +08:00

要不从里面开源一些有趣实用的代码出来哈哈哈

ruby0906

2020-08-15 14:44:44 +08:00

善战者无赫赫之功！

runningman007

2020-08-15 15:23:12 +08:00

我从来不写注释,代码我还会加密：）

LeoZhu

2020-08-15 15:34:55 +08:00

吐槽归吐槽，楼主爽完了以后还是该写注释写注释，该写文档写文档，对自己好

goodboy95

2020-08-15 15:43:10 +08:00

偏个题，一看见“教傻子的标准”，我就想起以前那些让人去百度的图：
“这是鼠标，这是键盘，这是电脑屏幕。开机之后，电脑屏幕显示的这个是鼠标指针，这些图标是浏览器图标。移动鼠标到浏览器图标上，快速按两次鼠标左上方的按键。再将指针移到上面输入文字的框，点一下鼠标左键，用键盘输入 www.baidu.com ，最后按一下 Enter 。最后在屏幕中间的框里面输入你要问的问题，按一下 Enter 。”

matatabi

2020-08-15 15:45:50 +08:00

哈哈证明楼主写的文档很好，给你一个赞

ChoateYao

2020-08-15 15:46:28 +08:00

写的文档自己存档就行了，没必要为他人提供方便，真的以为程序员的世界没有竞争？？见过同事 Copy 了我代码在他的项目用，然后去跟领导邀功，申请成为部门内部标准库的？

xuhaoyangx

2020-08-15 15:50:56 +08:00

挺好的。现在公司文档注释一坨屎。

xrr2016

2020-08-15 16:10:29 +08:00

@shellus 🐂🍺

leven87

2020-08-15 16:13:28 +08:00

看公司，看人，看对方的态度。

liuzhaowei55

2020-08-15 16:18:34 +08:00

文档是写给自己看的啊

zzk5173760

2020-08-15 16:26:46 +08:00

别，写文档是好习惯，坚持，提升和舒适是自己的，总会遇到同类，别为了这个让自己变得跟他们一样

efcndi

2020-08-15 17:15:24 +08:00

@zhongjun96 #26 哈哈哈，想起来我之前在某家公司，因为空调太冷，我躲到某个没人用的小房间去办公，不大一会儿被行政和人事赶了出来，说公司领导说现在没有安排小房间住人的计划。

Torpedo

2020-08-15 17:36:30 +08:00

所以技术人找工作，一定要有个懂技术的老板

jessun1990

2020-08-15 17:43:31 +08:00

不要为这些庸人置气，请坚持自己的好习惯，不要为了庸人降低自己的标准。

bbqqddwhy

2020-08-15 17:50:38 +08:00

功德无量，被 LZ 注释照顾的实习生一定也会在以后的生涯里面毕恭毕敬的写注释。

laminux29

2020-08-15 18:46:07 +08:00

这个问题的本质是，题主你被别人坑了，所以你要去坑别人。

站在大环境的角度来看，题主这做法不对，会带坏整个环境风气。

站在题主个人的角度来看，这做法并不违背法律法规，而且快意恩仇能让自己开心。

所以，不赞成，也不批评。

但我是题主，我不会选择报仇，也不会选择一个懂技术的领导，而是会选择一个支持我的领导。

hareandlion

2020-08-15 19:13:29 +08:00

同意楼上的说法，不要为了庸人降低自己的标准，否则可能始终在泥塘里打滚。
另外最近被工作毒打之余学到了一个词，”知识的傲慢“，但又感觉捏着鼻子了解庸人甚至妄人的想法对自己毫无帮助，同样疑惑中。。。

drackzy

2020-08-15 19:53:50 +08:00

不要写博客，不要写面经，不要写注释

pastgift

2020-08-15 20:14:50 +08:00 via iPhone

楼主功德无量，请务必坚持贯彻自己的原则，整个软件业的发展靠的就是每个程序员点点滴滴的坚持和积累

netlichun

2020-08-15 20:43:51 +08:00

这只能说楼主是未遇明主，真正的伯乐会发现你的价值，楼主可千万不要因为公司操蛋而扔掉了自己的价值！

p1gd0g

2020-08-15 21:04:45 +08:00

所以老板信了吗~~

volvo007

2020-08-15 23:27:22 +08:00

消消气
人事做人事那还能叫人事吗

newtype0092

2020-08-15 23:36:45 +08:00

你明明做了件值得大吹特吹的事，不吹说明你低调，别人恰好有机会借你的成果吹牛只能说捡了便宜，你要为这事生气只能说明你心态不好。
你要因为这事把你本来的优点放弃了，那才真的蠢吧。
“精心维护技术文档，让实习生在短时间内可以维护整个项目”，这也是个很能说道说道的工作经历吧，写简历上不好么。

yousabuk

2020-08-16 00:01:07 +08:00

呵呵，工作就应该挤牙膏一样，你一次性把你自己掏空了，那么，你还有何价值呢？
教会徒弟饿死师傅，师徒关系都况且留一手，这个道理不懂吗？

资本世界本没有那么美好，充满了恶，资本的本性就是恶。

charlie21

2020-08-16 01:23:12 +08:00

@SJ2050cn 在技校里会打架的就是无可取代的人

levelworm

2020-08-16 02:17:58 +08:00 via Android

@newtype0092 是的，不过说实话他技术上的领导应该给他好评，看来他技术上的领导也不怎么样。。。换我的话肯定季度或者年底评估的时候就都写上去了。该员工工作认真负责，且文档写的及其详尽，有效增加了整体工作效率，建议加薪 XXX

alexzuo

2020-08-16 05:24:50 +08:00

不建议楼主以后不写文档，建议楼主以后碰到这种事情，在老板路过的时候大声一点说:“我文档写的很清晰了，比你上学的课本还清楚，别说你是实习生，就算你刚上大学，看了文档也应该明白。你照着文档做就行，有问题先查文档，文档里没有再来问我”
一定要大声，要让老板听见。

mostkia

2020-08-16 10:08:18 +08:00

怎么说呢，你的代码文档，的确实实在在帮助了接手的人了啊，其实换个角度想，你自己也得到实惠了，至少不会被个二货菜鸟天天烦了。写文档注释，本身就是前人栽树后人乘凉的工作，你维护的好，人人都能看懂，你就越会有可能被替代，如果不想那样，那从今往后，多多少少“自私”一些，不是说开始堆屎山。而是说，代码注释点到为止就可以了，不必解释的很详细，自己看得懂就 ok 了。或者可以文档和代码分离，让整个程序的解释权都掌握在自己的手里。

sa2501

2020-08-16 10:11:58 +08:00

你不是一个人

jadec0der

2020-08-16 12:25:33 +08:00

难道 HR 觉得没你不行，你就回那个公司去？成天研究一个小公司 HR 的想法，能有什么出息

zjsxwc

2020-08-16 13:02:48 +08:00 via Android

当前环境下程序员越来越内卷化很正常，
1%的人掌握社会 80%甚至更高的财富的大势也不能改变，
对于个人来说最有利的策略，是既然打不过内卷化，就加入内卷化大军。

caicaicaibird

2020-08-16 16:53:28 +08:00

说明你离职多了一条理由，离职离得对。hr 向老板邀功正常不过来，理他干嘛。

bianqurenfm

2020-08-16 17:37:37 +08:00

这有点像是扶了老人一把反被讹了，然后问以后我们看到老人还扶不扶的问题

touno

2020-08-16 19:32:00 +08:00

别在意这些，过几个月跟你那些之前的程序员同时聚聚他们就会跟你吐槽，卧槽！那个新来的实习生文档都不会写，***的看不懂啊喂！还要我们去教他怎么写！真是****，真怀念我们一起共事的时光~等云云~哈哈哈

一般注释也是写自己看得懂就好了，交接的时候最好也是介绍清楚你的文档内容，离职以后短时间内能帮就帮吧，不帮也没事，你没必要为这事特意说啥，反正拿多少钱做多少事，程序员都懂的。