如何才能写出高质量代码?

2018-05-31 12:03:44 +08:00
 TheSpectre

最近在公司写一些业务代码,功能虽然实现了,但是感觉自己写的代码很乱,过几天再去看可能自己都看不懂了更别说别人去看你的代码。各位有什么建议

4438 次点击
所在节点    程序员
34 条回复
TheSpectre
2018-05-31 19:30:46 +08:00
@noNOno 谢谢
kinghui
2018-05-31 19:36:24 +08:00
把下面基本书多撸几遍

- 《程序员修炼之道:从小工到专家》
- 《重构:改善既有代码的设计》
- 《代码大全》
- 《代码整洁之道》
- 《设计模式》
kinghui
2018-05-31 19:40:14 +08:00
《代码整洁之道》里有提过,如果代码需要注释那就说明代码表达力不够,而且注释很容易不跟随代码更新从而误导读者(有可能是你自己)。如果你要为某段代码添加注释那么就应该考虑是不是应该换个名字或使用更加富有表达力的代码,如提取到单独的方法并起个好名称。
cxbig
2018-05-31 20:18:59 +08:00
多写多练
备注写清楚就不会忘记代码是干什么的
至于结构的规划,是写一个方法做所有的事情还是写一堆可重用的库、应用层只做配置和调用,全凭经验积累。
Foolt
2018-05-31 20:51:23 +08:00
@kinghui 表达力再好,几万行的项目里不可能没有注释,尤其是补丁类代码,不写注释后人翻半天才知道你这到底干嘛用,这种情况下阅读代码比翻阅屎山还恶心。
Foolt
2018-05-31 20:55:18 +08:00
最重要的是按编程规范写,PHP 比较流行的编程规范是 PSR 规范;
其次是鼓励冗长的命名,避免用缩写,如果非要缩写一定要在注释写出完整名称;
最后是不要忘了写注释,注释又长又臭没关系,不影响工作进度就可以。
night98
2018-05-31 21:37:35 +08:00
@kinghui #23 要么变量名全称,否则不用注释真的看起来很难受,尤其类似 redis 缓存命名这种,不看注释你都只能靠猜。
page470075640
2018-05-31 21:53:59 +08:00
一颗迭代的心
qloog
2018-05-31 22:00:33 +08:00
命名一定要有意义,这样后期看起来就不那么费解了。
monkeylyf
2018-05-31 22:03:36 +08:00
追求美
misaka19000
2018-05-31 22:29:39 +08:00
重构,多思考,把组件按模块进行划分
woscaizi
2018-05-31 22:32:59 +08:00
如果时间允许,多次重构。
kinghui
2018-06-01 10:01:20 +08:00
@Foolt
@night98
并不是说不要注释,意思是加注释是最后的办法,要先考虑有没有更好的表达方式,应该把加注释作为最后的选择而不是第一选择,每次把每次加注释都看作是承认代码表达力的失败而作出的妥协。
429463267
2018-06-01 11:14:21 +08:00

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

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

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

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

© 2021 V2EX