以前很难理解老程序员不写注释,不写文档,代码不规范,命名不规范。现在开始懂了。。。

2023-03-07 14:07:43 +08:00
 jeremylai

以前接手别人写的代码,到老员工代码,一个注释都没有,运气好的话,有人给你解释以前的业务逻辑,或者给你看以前的文档。要是运气不好的话,只能自己慢慢琢磨了。

后面写注释,命名规范,代码规范,写文档。开发也花了更多的时间。

后面想想,代码的可读性越强,你的可替代性不也是越强吗?花更多的时间,优化自己。

18739 次点击
所在节点    程序员
124 条回复
lakehylia
2023-03-07 14:09:27 +08:00
你又不是做对外的 SDK ,写什么文档,写文档又不算 KPI 。
anakinsky
2023-03-07 14:13:57 +08:00
花那时间干嘛,早点下班不好嘛
jeremylai
2023-03-07 14:18:19 +08:00
@anakinsky 确实是呀
zzzzz001
2023-03-07 14:18:40 +08:00
确实,突然悟道了,怪不得我 2 年毕业 2 次
j717273419
2023-03-07 14:25:26 +08:00
不要想太多,其实就是工期紧,如果工期不紧,我还想加 unit test 呢。现实是刚上线一个,另一个项目马上来了。没有喘气的机会
chendy
2023-03-07 14:25:43 +08:00
有限的时间内做足够的事情就行,满足需求,不用太好,别太垃圾,不给后人挖坑,也不给后人铺路,完事
加班加点把事情做得很好,说明有能力有责任心,但是这个东西要让领导看见、要让领导理解、要让领导认可,否则多少浪费时间
至于什么不可替代性…吃屎是老码农基本功,而且如果恶心不到别人天天恶心自己也不是那么回事
hervey0424
2023-03-07 14:26:03 +08:00
有文档但是没有及时更新, 这个还不如没有文档, 看文档还不如不看, 但是别人觉得有文档很容易
buffzty
2023-03-07 14:27:53 +08:00
我代码中几乎不写注释,api 文档会写在 wiki 中,代码规范,命名也规范.
当你代码规范 命名也规范时根本用不着写注释. 目录名 函数名 变量名就是最好的注释
jeremylai
2023-03-07 14:33:54 +08:00
@zzzzz001 悟了悟了,哈哈哈
jeremylai
2023-03-07 14:35:23 +08:00
@chendy 是的,做好基本的要求,只要不犯很大的错,就无所谓。我说的是可以替代性,和你说的不一样,只是没那么容易替代
vagranth
2023-03-07 14:52:17 +08:00
程序员悖论嘛。

你架构做得好,代码易读易扩展,随便谁都能接手。你是可有可无的人。
你代码写得好,没什么 bug ,天天不加班。你是工作态度不积极的人。
你代码写的不好,bug 成堆,天天加班。你是公司的骨干。
你架构一团糟,代码除了你自己没人敢碰。你是公司的重要人物,项目没你就垮了。
optional
2023-03-07 14:53:23 +08:00
大部分注释都是多余的
yvescheung
2023-03-07 14:59:15 +08:00
文档还是要写的,只不过是写给自己看,不然过段时间自己也看不懂写的代码了
fsdrw08
2023-03-07 14:59:36 +08:00
问题代码不加注释,过了段时间后,连作者本人都不知道写了个啥那怎么办?
Hurriance
2023-03-07 15:04:33 +08:00
我觉得更多的不在于技术上的问题,或者某一个人的问题。
changhe626
2023-03-07 15:06:05 +08:00
就国内的情况还写文档,你能把功能开发完了就不错了,一个迭代接着一个迭代,恨不得两个迭代放在一起做。你有时间把代码写完就不错了,还文档,测试的代码, 想啥昵
rationa1cuzz
2023-03-07 15:09:11 +08:00
关键是开你也不会考虑你的工作有没有人接手啊,又不是一个人干一个项目
lambdaq
2023-03-07 15:10:19 +08:00
以前写文档的原因是很多场合是重工业和军工,写文档的人都是有 pension 有编制的,把编程当成一种为客户服务的事业在做的。。。
jjwjiang
2023-03-07 15:10:46 +08:00
个人觉得,如果不写注释的代码看不懂,那这代码多少有点问题
bfdh
2023-03-07 15:13:28 +08:00
并不认同这个观点。
我觉得根源在于公司管理混乱,对这文档没有要求,项目时间规划的时候根本就没预留写文档的时间。
一段代码写完之后,后面都是修修补补,维护久了,实在无趣。所以我巴不得赶紧把自己写的代码交出去,有个靠谱的人继续维护,而我自己可以开始更有挑战性的工作。

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

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

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

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

© 2021 V2EX