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

[loliordie]

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

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

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

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

[Mindjet]

@gimp #19

同意(o´ω`o)و

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

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

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

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

[JamesR]

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

[faceRollingKB]

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

[Jirajine]

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

[leafre]

哪来的时间写注释

[zhongjun96]

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

[ruike007]

有这样的环境，留着无用

[shellus]

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

[hoyixi]

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

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

[AlohaV2]

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

[across]

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

[vanxy]

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

[puzzle9]

工资好高 我好羡慕

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

[levelworm]

@shellus 牛逼，写的不错

[puzzle9]

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

[mywaiting]

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

[Jirajine]

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

[puzzle9]

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

[loliordie]

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

[sanxianA]

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