按关键词阅读: 数据库 程序员 伪代码 测试用例 README
文章插图
文章插图
给变量、函数取个好名字ITWorld 曾经发起了一个”程序员最头疼的事情“投票 , 结果非常有趣 , 近半数的程序员认为命名是最头疼的事情 。
文章插图
规范的命名对于阅读程序是如此重要 , 本文开篇就不得不提到它 。 在阅读代码时 , 理解一个变量和函数都是从名字开始的 。 它是什么?它的职责是什么?这些问题从名字就应该看出来 , 如果名称需要注释来补充 , 那就不算是好名字 。
例如:将变量名
文章插图
修改为:
文章插图
将函数名
文章插图
修改为:
文章插图
宁可名字取长一点 , 也不要起个模糊的名字 。 一个清楚的变量名还会带来可搜索的好处 。 即使在写二分算法时 , 也尽量别用"l"和"r"来指代左右边界 , 换成"left"和"right"会更好 。
【README|编程中有哪些好习惯一开始就值得坚持?】不过 , 变量名也并非越长越好 , 去除变量名中的冗余也是一个好习惯 。 Variable 一词永远不应当出现在变量名中 , Table 一词永远不应当出现在表名中 。nameString 与 name 没区别 , moneyAmount 与 money 没区别 ,customerInfo 与 customer 没区别 ,theMessage 也与 message 没区别 。
命名风格应该保持统一 , 每个概念对应一个词 。 如果一堆代码中既有 Controller , 又有 Manager , 还有 Driver , Presenter , 就会令人困惑:他们之间有什么区别?为什么不全用 Controller?如果同一概念可被多个词语描述 , 请确定其中一个名字 , 并在你的代码中一以贯之 。
总之 , 取一个精准的名字是一名优秀程序员的基本功 。 从一开始学习编程时 , 每次取名都应仔细思考 , 切不可草草了事 。
文章插图
保持代码美观感受一下两种格式的代码:
文章插图
文章插图
同样的代码 , 仅仅是加上空格与缩进就能看起来更美观 。 现代化的 IDE 都有代码格式化快捷键 , 在代码敲完后随时格式化 , 并去掉多余的空行 , 是一个让代码保持美观的好习惯 。
文章插图
先想通逻辑 , 再写代码斐波那契程序员:每天都在修复昨天和前天的 bug你是否有过这样的经历:代码删了又写 , 写了又删 。 在敲代码之前 , 先问自己一个问题:我写下的这行代码是真的能用上的吗?会不会有逻辑漏洞?思考清楚业务流程之后再写代码 , 往往事半功倍 。
以笔者亲身经历过的一个项目为例 , 项目已经做了一年 ,除了三方库 , 代码量共有两万行 , 平均算下来 , 开发者一年来每天只需要写 55 行代码 。 这样看来 , 开发者的每一天都差不多是”很闲的“ , 然而开发者每天都忙得不得了 , 从早到晚都在码代码 。 这些代码量如果纯粹敲出来 , 最多十个小时就可以完成 。 我们应该用大部分的时间思考代码逻辑 , 不要花大量时间将代码删了又写 , 写了又删 。 磨刀不误砍柴工 , 事先做好全面的考虑 , 争取让写下的每一行代码都有价值 。
文章插图
程序员的时间分配
梳理代码逻辑是有一定方法的 , 例如: