论代码注释的重要性

lizhaoming

现在看以前离职同事写的炬芯手表的项目代码，想要在上面更换一些心率器件(把汇顶的gh3018换成ADI的ADPD7000)，注释少得可怜，钻研起来真的非常痛苦，而且炬芯用的还是zephyr，真的搞不懂，感觉实在搞不下去，好想跑路了

Osmond

困难告知老板，让他加钱。

yono

不好评价，这应该也是两个流派。
我坚持尽可能每个部分(大概3~15行)都必有注释。我老大坚持除了函数功能、一行注释都没有，而且坚称没有注释才是好代码。据他说注释反而产生误导，暂不清楚不写注释的考虑。

eric2013

晦涩的代码，可以让copilot帮你理解下，很多代码之所以晦涩是程序层次逻辑结构整不顺溜。

YH_Zhang

最好是自注释，即通过变量名、函数名可以看出来，手动注释的话，经常会改了代码，忘记或懒得改注释了，其他人经手或长时间再看代码时，就会遇到困惑

PKB404

刚入职接手屎山，我直接推倒重做，适合自己风格舒服多了

Zhyolo

eric2013 发表于 2024-8-16 11:07
晦涩的代码，可以让copilot帮你理解下，很多代码之所以晦涩是程序层次逻辑结构整不顺溜。

我们公司的屎山 copilot 都崩溃了，直接摆烂不解释了

Zhyolo

PKB404 发表于 2024-8-16 16:51
刚入职接手屎山，我直接推倒重做，适合自己风格舒服多了

那你是没遇到屎山没文档，没说明的情况，重做基本等同于市面上随便找款设备然后抄，还得实现其中的隐藏功能

Osmond

Zhyolo 发表于 2024-8-19 09:08
我们公司的屎山 copilot 都崩溃了，直接摆烂不解释了

哈哈，详细说说

会飞的猪_2020

写注释主要太花时间了。
我看我们公司的有个高手，他的程序就是框架很复杂，然后不写注释。
只能根据函数名称去判断每个函数是做什么用的。

而且由于本人水平不足，他里面的很多写法不花大量时间去看，根本看不懂。
然后领导急着催我做一个模式切换...

最后我只能一狠心，反正芯片资源够用，然后又上了rtos。而且两个模式是独立的。
我就没管他那边是怎么写的...自己重新开了一个任务，去实现了新的功能。

导致我这个程序变成了屎山。每次不是我写的那部分代码，如果要我去修改的话，我总是很痛苦。
陆陆续续花了好几个月，才大概明白了一点，他是怎么写的业务逻辑。。

会飞的猪_2020

写注释主要太花时间了。
我看我们公司的有个高手，他的程序就是框架很复杂，然后不写注释。
只能根据函数名称去判断每个函数是做什么用的。

而且由于本人水平不足，他里面的很多写法不花大量时间去看，根本看不懂。
然后领导急着催我做一个模式切换...

最后我只能一狠心，反正芯片资源够用，然后又上了rtos。而且两个模式是独立的。
我就没管他那边是怎么写的...自己重新开了一个任务，去实现了新的功能。

导致我这个程序变成了屎山。每次不是我写的那部分代码，如果要我去修改的话，我总是很痛苦。
陆陆续续花了好几个月，才大概明白了一点，他是怎么写的业务逻辑。。

caicaptain2

人的定位不同，对写注释的态度就不同。
普通员工是不愿意写注释的，这样子不容易被替代，或者替代成本很高。即使公司有要求，也是阳奉阴违。
老板是会要求必须注释的，方便产品升级和人员接替，减少产品失控的风险。
有潜力和主动性的员工是愿意写注释的，方便自己总结和反馈，而且有时候也需要转交工作给新人，自己才有上升的空间。

这几种人都碰到过。也可以通过这个现象来识人。

Osmond

先做功能设计，然后拆分模块、数据结构，再根据设计实现代码

imliyucai

caicaptain2 发表于 2024-8-26 09:18
人的定位不同，对写注释的态度就不同。
普通员工是不愿意写注释的，这样子不容易被替代，或者替代成本很高 ...

老兄看得很透。

注释不应该很多，但比较难理解的地方一定要有。
基本上没有注释的代码，可以肯定不是很好的代码。

txt1994

yono 发表于 2024-8-15 18:02
不好评价，这应该也是两个流派。
我坚持尽可能每个部分(大概3~15行)都必有注释。我老大坚持除了函数功能、 ...

看过这个理论， 说是好的代码自己就是注释