以前接手别人写的代码，到老员工代码，一个注释都没有，运气好的话，有人给你解释以前的业务逻辑，或者给你看以前的文档。要是运气不好的话，只能自己慢慢琢磨了。
后面写注释，命名规范，代码规范，写文档。开发也花了更多的时间。
后面想想，代码的可读性越强，你的可替代性不也是越强吗？花更多的时间，优化自己。
• 请不要在回答技术问题时复制粘贴 AI 生成的内容
This topic created in 1339 days ago, the information mentioned may be changed or developed.
Supplement 1 · Mar 8, 2023
很多人都把注意力放在被优化上,我只是说被优化的难度就减少，不是说不会被优化，老板一句话就可以让你滚。
还有老哥以为我要故意写错代码，故意写不好代码，不也得花时间吗？我的意思是基本符合规范就可以了，怎么方便怎么来，花时间在做规范，注解，写相关文档上，那就得不偿失了。
 |
1
你又不是做对外的 SDK ，写什么文档，写文档又不算 KPI 。
|
2 |
2
花那时间干嘛，早点下班不好嘛
|
 |
4
确实，突然悟道了，怪不得我 2 年毕业 2 次
|
 |
5
不要想太多，其实就是工期紧，如果工期不紧，我还想加 unit test 呢。现实是刚上线一个，另一个项目马上来了。没有喘气的机会
|
 |
6
有限的时间内做足够的事情就行，满足需求，不用太好，别太垃圾，不给后人挖坑，也不给后人铺路，完事
加班加点把事情做得很好，说明有能力有责任心，但是这个东西要让领导看见、要让领导理解、要让领导认可，否则多少浪费时间 至于什么不可替代性…吃屎是老码农基本功，而且如果恶心不到别人天天恶心自己也不是那么回事 |
 |
hervey0424Mar 7, 2023
7
有文档但是没有及时更新, 这个还不如没有文档, 看文档还不如不看, 但是别人觉得有文档很容易
|
 |
8
我代码中几乎不写注释,api 文档会写在 wiki 中,代码规范,命名也规范.
当你代码规范 命名也规范时根本用不着写注释. 目录名 函数名 变量名就是最好的注释 |
 |
11
程序员悖论嘛。
你架构做得好，代码易读易扩展，随便谁都能接手。你是可有可无的人。 你代码写得好，没什么 bug ，天天不加班。你是工作态度不积极的人。 你代码写的不好，bug 成堆，天天加班。你是公司的骨干。 你架构一团糟，代码除了你自己没人敢碰。你是公司的重要人物，项目没你就垮了。 |
 |
optionalMar 7, 2023 via iPhone
12
大部分注释都是多余的
|
 |
yvescheungMar 7, 2023
13
文档还是要写的，只不过是写给自己看，不然过段时间自己也看不懂写的代码了
|
 |
14
问题代码不加注释，过了段时间后，连作者本人都不知道写了个啥那怎么办？
|
 |
HurrianceMar 7, 2023
15
我觉得更多的不在于技术上的问题，或者某一个人的问题。
|
 |
16
就国内的情况还写文档，你能把功能开发完了就不错了，一个迭代接着一个迭代，恨不得两个迭代放在一起做。你有时间把代码写完就不错了，还文档，测试的代码， 想啥昵
|
 |
rationa1cuzzMar 7, 2023
17
关键是开你也不会考虑你的工作有没有人接手啊，又不是一个人干一个项目
|
 |
tf2Mar 7, 2023
18
以前写文档的原因是很多场合是重工业和军工，写文档的人都是有 pension 有编制的，把编程当成一种为客户服务的事业在做的。。。
|
 |
19
个人觉得，如果不写注释的代码看不懂，那这代码多少有点问题
|
 |
20
并不认同这个观点。
我觉得根源在于公司管理混乱，对这文档没有要求，项目时间规划的时候根本就没预留写文档的时间。 一段代码写完之后，后面都是修修补补，维护久了，实在无趣。所以我巴不得赶紧把自己写的代码交出去，有个靠谱的人继续维护，而我自己可以开始更有挑战性的工作。 |
 |
karmaisbitchMar 7, 2023
21
复杂业务还是得写一点注释，经常过个半年回来看代码都忘了当初为啥要写这一段
|
 |
jorneyrMar 7, 2023
22
但行好事，莫问前程。
|
 |
23
@karmaisbitch 就是更多的是为了自己考虑，少为公司考虑，不然到时候就容易的开了
|
 |
yuancoderMar 7, 2023
24
大部分情况下看不懂代码，并不是真的看不懂，而是不知道为什么这么写。
这跟写不写注释关系不大，如果注释只是在描述这段代码在干什么，过一段时间后，还是不知道为什么这么写。 |
 |
25
说起来之前写了一个 vscode 的插件，作用就是在本地对代码进行注释，只有自己电脑才能看到。感觉是不是也有不少人有这个需要？
|
 |
AlexHsuMar 7, 2023
26
写文档注释这种事就是将心比心的事儿 正常开发的工时至少的给出一半来写文档 不给时间自然就不写 没什么可说的
|
 |
lessMonologueMar 7, 2023
27
@ghostben 老哥发出来吧，刚需。目前是通过 bookmark 功能来用的
|
 |
loopljMar 7, 2023
28
虽然但是，代码写的烂，可替代性还是强，该毕业还是得毕业。
|
 |
29
对于工作了 10 多年，有那么一点点管理经验的我，是不认同这个观点的。
凡是不定注释，代码不规范的在我眼里都是工作能力不行的，绩效不会很高，工资、职位提升也很有限。如果要开人，第一个开的就是这种人。 代码是评价一个程序员最直接的东西了，你丢给别人一堆垃圾，期望别人对你大加赞赏，升职加薪？你觉得这逻辑走得通么。故意这么搞，最终就是落得人走了，名声在同事里也不好，领导觉得能力也不行。 开发时间太紧，需求频繁变更导致代码可读性不好，这还说得过去。但你至少写出一些工整，规范的代码给别人看，让别人知道你的能力是很不错的啊，这才有可能给别人留好印象，无论是升职加薪，还是以后介绍个工作，内推一下，都有可能。 你如果觉得公司给的钱不够多，那你可以慢点干，出的活少一点，但至少活还是干得漂亮的。或者你直接跳到个给的钱多的公司，那也能理解。 不要迷信什么不可替代，程序员 99.99%的活都是给钱就有人能干。那些代码写得工整规范的程序员也能干，无非就是又跑到某某论坛发个帖子大骂前一个老员工留下一堆垃圾。 对老板来说，开人的时候压根没想过你活干得怎么样，人家是从成本核算来开人的，好的不好的都开了 |
 |
30
 |
 |
yaphets666Mar 7, 2023
31
@changnet 问下大佬，你们团队是规定所有代码都写注释吗？我没有在特别规范的团队干过，想了解下
|
|
changnetMar 7, 2023
33
@yaphets666 我们公司做得并不是很好。规范有要求要写注释。但有些人不写，也没有强制的措施，公司没有 svn hook 或者 ci 之类的东西来做检查。只是偶尔看到会口头说一下
|
 |
tedioreleeMar 7, 2023
34
像我们公司不允许随便写注释的有没有，除非涉及到特殊的业务需要解释
|
|
35
@changnet 既然没有强制，只是偶尔说一下，那多做了，为了你的理想工作吗？如果只是你个人主观意愿，没有回报，一次两次没啥，经常这样子，不就是欺负老实人吗
|
 |
aliveyangMar 7, 2023 via Android
36
人的问题，有些人不讲究，有些人不将就
|
|
37
@jeremylai 你不这样做，怎么培养你的编码习惯，怎么提升你的编码质量？难道说在公司写 5 天垃圾代码，周末 2 天就按自己的规范写好代码，能分得这么清？
你在公司不好好写，以后你的同事跳槽了，敢内推你去再做一次同事吗？你的同事出去创业了，看到你代码一团糟，敢带你吗？ 你这不是自己坑自己么。你对当前公司不满，有很多种方式可以处理，为什么选择这么一种来坑自己。你觉得对公司有什么损失吗？对公司而言只要代码能跑，钱赚到就完事，你同事多加班两小时去整理你的代码，对公司来说不算事。 |
 |
myselflove8090Mar 7, 2023
38
不要迷信什么不可替代，程序员 99.99%的活都是给钱就有人能干。。。。。。。。。
|
 |
FelldeadbirdMar 7, 2023
39
楼主错误理解，走火入魔。
代码可读性强不代表可替代性高啊。你说 linux 的代码可读写怎么样？ 老板铁了心要优化你，后面的人接手只要花时间一样可以读清里面的逻辑。 你想想你一个人把公司打理得规划整齐。你被裁了后，后人可不一定有你这般水平的。到时候要试错 N 次 都不一定解决到。 |
|
myselflove8090Mar 7, 2023
40
想起国外那哥子上班外包给中国人的事。。
|
 |
FuleMar 7, 2023
41
这种“人工混淆”是全局杀伤，包括几个月之后的你自己。几个月之后如果你需要改代码，也不比别人有多少“优势”，除非你记忆力超强。而且改代码也会更耗费时间，以前“省”下的时间在改代码的时候都会补上，而且每改一次就补一回。如果组里大家都这样，想想每个人都释放全局杀伤的场面，我觉得属于互相伤害。我觉得老代码那些问题，部分属于能力问题，部分属于赶工期原因，为了你说的理由而那么做的话，我觉得是得不偿失，除非是抱着跑路心态。
|
 |
zpxshlMar 7, 2023
42
之前有个前同事面我现在的部门，领导问我对这个前同事了解吗，我想起了他的代码水平...
|
 |
43
可预期的被喷了
有些事懂了就懂了 但你说出来就不好了，分明是大家排期紧工作忙忘记写了🤪，你这样说就成了恶意乱写。 每个公司有自己的工作方式，懂的自然懂。 |
 |
xiaoxiaoming01Mar 7, 2023
44
@ZSeptember
还是要看写烂代码是 [故意的] 还是 [不小心的] 🤭🤭 |
 |
superedlimitedMar 7, 2023
45
jetbrains 家的 ide 写代码的话，推荐一个插件，private note ，只能自己看到的注释 ：）
|
 |
misaka20Mar 7, 2023
46
大部分人蜜汁自信。
我觉得以国内复杂的需求，该写注释还是写注释，大部分人没那么能力写读性高的代码，还是老老实实地注释吧。 |
 |
wqhuiMar 7, 2023
47
哪怕变量、方法自认为命名的很好，注释也是有帮助的，毕竟中国人母语不是英文，看纯英文可能 get 到的意思有点不一样。而且命名一般也不会很长，几个单词就能解释清楚做了什么吗。给的开发时间充裕写详细一点，时间紧就简单写一些特别重要的
|
 |
charlie21Mar 7, 2023
48
今日谬论 1/1
|
 |
49
老生常谈，程序员付出了更多时间跟精力无法获得实质回报...
我一般将这类问题归为，系统性管理问题。之前的帖子有讨论过。 |
 |
Raven762Mar 7, 2023
50
就我们这测试都省了，每天一个变更还有不知道哪来的鬼点子，这周要的功能下周就又改了，还写个🔨注释呢
|
 |
zmqkingMar 7, 2023 via iPhone
51
当头棒喝……悟了
|
 |
tkHelloMar 7, 2023
52
恭喜进阶
|
|
tkHelloMar 7, 2023
53
队伍壮大了一点点。 一点点 一点点 一点点 一点点 ... ... ...
|
 |
AixtuzMar 7, 2023
55
目标是作品，那我怎么完美怎么来~
目标是收入，那你考核什么，我重视什么。 |
 |
mrzxMar 7, 2023
56
@changnet 首先，非常认可你的说法。任何人都是可以被替代的。
但是~~~~~~替代的难度是不一样。我宁愿给你加难度或者我走了你得重构。重构得花资源，得多花钱，哪怕对于老板来说是九牛一毛。我开兴就行。 而且很多时候不是不加注释，是肯定要加注释的，良好得编码习惯很重要。要对得起自己，并且自己会整理出来一套文档，但就是不给公司罢了 要说我这样的，你们公司不要，无所谓，我们还没沦落到去你们这样的公司。。。而且现在开发工作细化，每个人就负责那么一小块部分，明显就是资本家为了开发效率和提高替代性衍生出来的产物。那真的就是码农了 要知道以前像运营商级别的业务系统，很多就只有 1~2 个人开发出来的，正因为如此，很早的程序员技术不错，因为被逼的什么都要接触，前端，后端，数据库，操作系统，内核等等。。。到现在乙方公司还不敢动他们。除非等这套系统在运营商彻底淘汰。 现在的程序员。。哎。。一言难尽。。 |
 |
57
我觉得我代码写的像诗，不需要注释
我的同事觉得我的代码写的像屎，太过抽象无法理解 就算是诗，也有鉴赏等级的，很多经典意象和引经据典的东西，没学过他就是读不懂 所以，工期赶得不紧的时候我还是会写注释的 为了兼容水平参差不齐的同事们 |
 |
nothingistrueMar 7, 2023 via Android
58
1 ，过时的注释 /文档，比没有注释 /文档更可怕。2 ，要想注释 /文档不过时，成本非常大。认不清上面这两点的程序员，要么不够老，要么是人来经验不来，要么是假技术实管理（尤其是没编码几年就混上总监的）
|
 |
BUHeF254Lpd1MH06Mar 7, 2023
59
说真的有些特殊判断加注释我可以理解，普通函数，每行代码都加就没有必要了吧。拿函数名来举例，正常来说，你函数名起的够有概括性，代码拆分够好的话，都不用写注释，直接看函数名字不知道行了
|
 |
MandeloMar 7, 2023
60
只要给时间,都好说.
没人喜欢免费下班写文档 |
 |
wanguorui123Mar 7, 2023
61
想太多，公司不行了，该裁一个也跑不掉，留几个运维能重启机器就可以了，运维才是不可替代的
|
 |
hello2090Mar 7, 2023
62
不可替代性还不简单么？给公司大门上把锁，没有你公司开不了门，这不是无可取代？
|
 |
realpgMar 7, 2023
63
不写注释的代码很多
基本就是看方法名就知道是干啥的 功能模块拆分合适 里面怎么实现的基本合格程序员都简单清晰看得懂 你想重构你就重写好了 |
 |
javlibMar 7, 2023
65
最近用了 copilot ，爱上了写注释，注释写的越多，copilot 生成的越准。
|
|
charlie21Mar 7, 2023 via iPhone
66
code review 想不想过啦？
|
 |
opengpsMar 7, 2023
67
注释是写给自己看的，很多逻辑自己确实已经不需要注释了，当然会慢慢的都不再去写注释
|
 |
KimiArthurMar 7, 2023 via Android
68
@vagranth 所以只有 OSS 才是真正的软件开发！
|
 |
securityCodingMar 7, 2023
69
满足 lint 即可
|
 |
whyrookieMar 7, 2023
70
不重构可以理解，完全不写注释理解不了，一些比较晦涩的代码写一下注释也不会花多少时间，越来越觉得代码写规范一些是对自己的要求，和公司没啥关系。
|
 |
sniperking1234Mar 7, 2023
71
写设计文档，代码命名规范，写注释不是基本操作吗，这帖子里面很多回复让我疑惑
|
 |
loveourMar 7, 2023
72
不能赞同这个观点。真正导致被替代的肯定不是注释写得清楚。
另外，也不赞同好的代码习惯可以代替注释。好的代码习惯可以替代很多注释，但是总会有注释更好更清晰更易懂的时候。尤其是需要做一些兼容工作的代码，有时候不注释别人还以为代码没用，其实是为了解决一些稀奇古怪的问题。 |
 |
leon0918Mar 7, 2023
73
代码需要自解释，有些 code review 会要求
|
 |
b123405060Mar 7, 2023
74
好的代码, 目录, 类, 方法, 命名, 层级清晰, 有没有注释都行!
|
 |
75
公司管理塑造员工。什么样的公司出什么样的员工
|
 |
CoderLifeMar 7, 2023
76
if (a == null ) {
//判断 a 是否为空 } |
 |
ivveiMar 7, 2023
77
主要还是从方便自己出发。写了有收益就写，没收益就不写。
代码可读性这种东西就不要追求了。能不能看懂，和读者的背景、水平、习惯也是很有关系的。代码规范命名规范之类的跟狗屁差不多。网上代码那么多，几个符合你的规范？光缩进风格都有好多种。差不多得了，提高自己的适应能力才是真。 |
 |
FreshOldManMar 7, 2023 via iPhone
78
不写的话过一段时间你记得住这些垃圾代码吗
|
 |
HankLuMar 7, 2023
79
我还故意留下 bug ，留下后门，留下验证，留下过期时间。我走了几个月，保证这个 app 就用不了！
|
 |
THESDZMar 8, 2023
80
你是通过自伤 800 达成了伤人 1000,建议跳槽吧.
|
 |
dcsiteMar 8, 2023
81
@8355
出发点不同，写注释和文档的热情肯定也不一样。就拿开源软件来说，有的尽量文档注释特别细，有的没有注释逻辑还特别绕，不能说谁对谁错，都有自己的目的…… 写的代码太简洁好用，下场就是有你没你都行；写的代码是天书，大家虽然心里骂你，还得看你脸色行事：） 就像你说的，看得太多了，懂的都懂。 |
 |
dayeye2006199Mar 8, 2023
82
懂了，k8s 这种 i 项目注释文档都很齐全，所以我上我也行，我也能做 core contributor ！
|
 |
83
我也工作快十年了，从外包公司一路干到美国的大厂。据我观察，工作能力和前途大部分时候是正相关的。
一类是工作非常出色的人，你明显感觉他在这个公司鹤立鸡群，他经手的代码都很漂亮，如果要转给别人做，接手的人都会表示学到了。他们不担心被替代，反而公司会担心他们跳槽，但最后遇到好机会他们都跳槽走了。 另一类是很会混日子的人，同事不想和他们合作，PM 会避免把需求交到他们手上。缺人的时候公司不会动他，但是市场转冷的时候首先被裁的是这些人。 至于你说的工作做的不好，但是特别会刷题面试的人，我也遇到过很多，从小公司里看，是一个干活不好的同事靠刷题跳进大厂，工资翻倍的故事。从大厂里看则是面试失败，招进来一个光会说不干活的人，如果实在太差还要在试用期结束前劝退。毕竟如果工作能力不行，在什么公司里的发展都有限。 |
|
8355Mar 8, 2023
84
@dcsite #81 开源软件大多是为爱发电，是真正自己想干和热爱的事儿，而公司的项目更多的是糊口，不能想怎么干就怎么干，还得考虑团队能力 /后序维护的人 /内部规范 /为业务未来可能存在的变动留下冗余扩展接口 /救火 bug 的临时修堵等等，这些可能都会让代码变的不再极致。
开源项目绝大部分应该都是作者自己维护，了解所有代码和掌控未来的发展趋势一切东西相对确定不可控因素会大大减少，可能花 5 天 10 天时间研究一个算法或者架构能让性能提升 10%，这对自己十分有价值，对公司来说你花 5 天 10 天研究这个还不如多迭代几个版本写点新功能来的实在，只有业务量足够大特别需要这 10%性能的企业才会足够重视这个行为，但是绝大多数人是进不了这种公司或者到不了这种公司的这个岗位。 |
 |
murmurMar 8, 2023
85
|
 |
rm0gang0rfMar 8, 2023
86
可读性和文档有啥关系。。注释不仅仅是为了代码还有逻辑
|
 |
RemindersMar 8, 2023 via iPhone
87
看写的是否是有效注释吧，有的老哥写的不是注释，是废话，为了写注释而写注释。
|
 |
PromtheusMar 8, 2023
88
的确啊 代码写的再优雅也没人懂，只要功能实现了就行了。
|
 |
AindyMar 8, 2023
89
关键看人，我自己写过的代码，即使过了一年多再来看，仍然好修复跟扩展（即使注释不全的情况下）。 但是改别人的东西真的要我老命
|
 |
theprimoneMar 8, 2023
90
《代码整洁之道》
|
 |
mqtdut1Mar 8, 2023
91
注释是写给自己看的，不是给别人看的
|
 |
M003Mar 8, 2023
92
能跑起来就行.还要什么自行车.
老板要的敏捷开发,甚至以为跟你讲需求的同时,你代码已经写完了. |
 |
93
靠怀孕能留住男人么
|
 |
mageseMar 8, 2023
94
工作 6 年了，不管别人写不写注释，我是一定要写的，无论时间紧不紧。
至少是每个方法函数上都会写明这个方法是做啥的，出参和入参是啥，实际写起来也花不了几分钟。 |
 |
zimhyMar 8, 2023
95
之前小组领导搞事情，要求方法代码圈复杂度 20 以下，类 120 以下。于是状态机+设计模式+DDD 一通操作，成功达标，然后这些彻底没人敢动我写的代码了，滥用设计模式写出来的完全没有可读性。
代码复杂度只能被隐藏，不能被消除。 |
 |
yylxbiubiuMar 8, 2023
96
@j717273419 那你是不是很累
|
 |
MEIererMar 8, 2023
97
在国内一些私企，写得好也是罪
|
 |
vazoMar 8, 2023
98
以前可能行,现在有 ai 可以重构注释,怕是不会增加你的不可替代性哦.
|
 |
keepfunMar 8, 2023
99
作为很老的员工 我不写注释 是觉得 写了之后 感觉代码就乱了（复杂逻辑我会写一点注释） 个人不喜欢那些没用注释掉的代码（觉得就是死尸） 也不喜欢每一行都加注释的 还不喜欢简单的逻辑 也写一堆注释的
被人替代不替代，和这个没啥关系吧。 |
Select Language