程序员应该具备哪些良好的编程习惯?

news2024/9/22 19:34:00

本文首发自「慕课网」,想了解更多IT干货内容,程序员圈内热闻,欢迎关注"慕课网"!


培养一个好的编程习惯,能让你整个职业生涯收益。

例如,做好注释,方便自己也方便别人读懂代码;用科学的方法命名变量,而不是随心所欲;规范化测试,而不是拖到所有程序都完成再去测试,等等。

下面是一些值得坚持的好习惯,编程是个充满创意的工作,但同时也是细节决定成败的工作,你真正工作中可能80%的时间都在处理一些琐碎的问题。

所以,尽可能避免它们的频繁出现,会让你的职业生涯更轻松,也能更好的迈向成功。
一、技术层面
1. 初级技巧(技术细节)

1)我们知道在类C语言的编程语言中,int和bool是可以相互转换的。** 因此 a = 1 与 a == 1 都可以作为if的判别条件。很多新手会把“=”当成“==”,而这并不会引起报错。因此这种错误是比较难以发现的。一个小技巧是将判别条件写成:1 == a,这样如果误写为“=”,则会引起编译器的语法层面的报错,这样错误就会立刻被发现。

这个技巧只起到一个抛砖引玉的作用,编程语言种类繁多,但差不多每种语言里都能发现一些类似在类C语言中的这个技巧,这类技巧运用好了有时候能够节省大量时间。

2)善于利用位运算提高运行效率

在运算量较大的时候,善于运用位运算来代替一些普通的运算,往往可以起到提高代码效率的作用。例如,a * 2 可以写成 a << 1;再比如判断一个数字是否为奇数或偶数时,a & 1 要比 a % 2 的效率要高得多。
2. 中级技巧(代码的易读性)

1)空格的使用

很多新手程序员还没有体会到一个小小的空格作用能有多大:a=b+c 和 a = b + c ——— 对计算机来说这是一回事,但是对程序员来说却是完全两回事。当你面对成千上万行的代码要阅读时,你一定会感谢使用空格的程序员。

2)风格一致的代码

代码风格包括了代码本身的风格以及文件的命名。总之一切由你的手通过键盘写入到计算机里的东西,都应该保持一致的风格,包括文件名称、变量与函数名称、缩进等。这一点有经验的程序员一定深有体会,一致的代码风格不仅会方便你也会方便读你代码的人。

举个简单场景,你周围亲戚朋友有个两三岁的小孩,他说了两个字“gu hu”,每一个字你都听的很清楚,但由于音调和吐字的缘故很难第一时间就理解这两个字的具体含义,经过他妈妈的翻译之后,你恍然大悟:哦,原来说的是“姑父”。这就和风格不一的代码一样,你很难弄懂它的意思,要花费大量时间去解读敲代码的人的思维。

 3)命名要有含义

这一条不需要多解释,a = 1.2 和 price = 1.2 哪种更清晰一目了然。原则上,宁可让变量名或者函数名长一些,也不要起模糊的或没有含义的名字。

4)学会如何写注释

什么时候用注释,这是个古老的问题,它始终没有一个特定的标准。有这样一个说法:在一个健全的代码中,注释的部分应该是代码本身的二分之一到三分之二。小慕对这种说法不是很赞同,注释应该视情况而定,但这也说明了注释的重要性。永远不要相信,只要变量名函数名起得好,就不需要注释这种言论。

根据经验来说,在逻辑比较复杂的时候、容易踩坑的地方,注释是一定要写的。至于每个函数是不是都要写关于函数的返回值、参数这样的注释,要具体情况具体分析。如果项目要求你必须写,那无需多问;而如果项目没有这类硬性要求,那么对于那些经常被大家使用的较为复杂的函数,最好有注释。这样每个使用这个函数的人就可以通过注释很快明白如何使用这个函数。

另外,在一些函数体为空的地方,写一行注释也会起到积极的作用。比如:

void func () {}

void func ()

{

// nothing to do

}

当这两种写法出现在很多代码中时,很显然第二种写法要远好于第一种。

但是同时要注意,写注释也是有代价的。当你对代码进行修改时,相应的注释也要修改,这无形中就会增加工作量。如果你不小心忘记修改注释,那么很可能会让阅读代码的人产生困惑,也就是说:注释同样需要维护。因此切记不要滥用注释。
3. 高级技巧(debug)

1)用[控制变量法debug

很多新手往往意识不到一个事实:写代码本身并不会花太多时间,真正花时间的是debug。可以说,debug的速度可以直接反映出一个人的编程水平。debug的技巧,也许不同的程序员会有不同的经验之谈,不过真正能称得上是debug技巧的,只有两个:控制变量法 + 二分法。

所谓控制变量法,就是当面对多个不确定因素时,你要人为地修改这些因素,让不确定因素只剩下一个。请看这段代码:

if (func() < func2() && value > getSize())

{

// …

// …

}

当运行这段代码的时候,你发现本来不应该进入到这个if的情况下却进来了,此时需要找到问题所在。新手往往会觉得有点束手无策,因为这里有两个判断条件,到底是哪个出了问题?其实按照控制变量法去做,这样的debug会很容易被找到:我们只需要将一个条件暂时去掉,让程序执行,就可以立刻定位到错误的地方。

上面这个例子是一个真实的案例。其中,func和func2都是非常复杂的函数,而getSize()是朋友写好封装在库里的一个函数。bug是:value为-1而getSize()返回值是4的时候,居然执行了if里面的部分。其实bug的原因在于getSize的返回值类型是unsigned int,而-1是int类型,因此 -1 > 4 成了true。面对这样的bug,如果通过加断点的方式去逐步执行,那么依然需要花费很多时间才能找到这个错误。而如果把func() < func2() 先去掉,只留下后面的判断条件,那么立刻就可以定位到错误。

2)用二分法debug

面对大量代码出现bug时,想要在用极短的时间找到错误,就可以使用“二分法”。举个例子:

// a) 此处有1000行代码

// b) 你感觉bug大概在这个位置

// c) 此处有2000行代码

此时并不需要读懂a处和c处的代码,只需要读懂b处的代码即可。更准确地说,只需要知道b从a那里获取了什么、b给了c什么即可。

假设b处的代码依赖于a处代码所生成两个值,那么完全可以直接把a处的代码全部注释掉,而后模拟两个值给b,再运行,看看结果如何。如果bug依然存在,那就说明a处的代码没有问题 ——— 至少这个bug的源头不在a处;而如果bug消失了,则说明bug源自a处的代码。

比如:

int func ()

{

// 1000行代码

return x;

}

void func2 (int a)

{

// 2000行代码

}

int a = func()

// 改变了a的值

func2(a)

如果这段代码报错,最快的定位bug的方法是先模拟一个参数给func2,看看bug是否还在,如果bug还在,则说明func2有问题;反之,则说明问题出在之前的代码。新手们如果可以学会灵活运用这种方法去debug,相信很快就可以步入“老油条”的行列。

debug其实和找对象是同样的道理,要讲究方式方法,才能避免注孤生的命运。例如:

不要讲她听不懂的编程知识!

修电脑一定要跑去她家!

能区分女生说生气不理你了并不是真的不想理你!

……


二、工作、学习层面
1. 不断温故编程基础知识

 

对于事物而言,最基础的往往是最核心的。不断温故编程基础知识,理解编程的思维体系,知其然,知其所以然,才能运用的得心应手。才不会找了半天错误最后一拍脑袋:哦,原来在这出错了。

有个编程新手,前段时间写了一个代码,逻辑是这样的:一个超链接请求后台,但是点了链接之后,页面刷新,后台请求没有走到。他找了好久都没有发现问题。最后让资历较高的同事一看,他的A标签写的是这样的:

<a href="" οnclick="getUserInfo();"/>。于是改成了

<a href=”javascript:void(0)” οnclick=”getUserInfo();”/>。同事改完扭头就走,他这才恍然大悟。

 

2. 体系化罗列,碎片化整理

很多人说,自己高三那年是人生知识储备的巅峰时期,就是因为当时最主要的任务就是学习,每天反复背诵相关知识点。但是哪怕当时记得再清楚,随着时间的流逝,大学之后没有温故知新的话,很多东西就会慢慢遗忘。这就是人记忆的一个遗忘曲线。

对于编程,语言和技巧太多,指望过目不忘是不可能的事情。买一个笔记本,或者利用各种云端程序,体系化地罗列出自己的编程语言条目,条目下细分出详细的模块,平时工作、闲暇之际接触有优秀的观点、实用的技巧、深入的剖析原理都可以碎片化记录下来。这样可以方便平时翻阅,只要坚持一段时间,就会发现自己专业技术提升不少。其实也不仅仅是编程,在任何一个行业,没有不用付出就能登顶的天才。学习编程本身就需要时间和经验的积累,在勤奋的基础上,坚持良好的习惯和正确的方法论,成不成功不敢说,进步肯定会有的~


欢迎关注「慕课网」帐号,我们会一直坚持提供IT圈优质内容,分享干货知识,大家一起共同成长吧!
 

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.coloradmin.cn/o/456327.html

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈,一经查实,立即删除!

相关文章

hot100:数组——56、64

56. 合并区间 首先考虑只有两个区间的情况&#xff1a; 但是这6种情况可以合并成3种情况&#xff0c;就是上面的3种。首先先判断第一个区间的起始位置是否小于等于第二个区间的起始位置。如果不成立&#xff0c;则交换两个区间。 再考虑n个区间的情况&#xff0c;先将他们根…

QML中【预计符号】和【Unknown Component M300】的红色警告解决方法

问题描述&#xff1a; QML的项目中带中文&#xff0c;每次打开项目都在问题栏显示【预计符号】的红色警告&#xff0c;还有一种是【Unknown Component M300】的警告&#xff0c;代码能正常编译和运行。像我这样对代码追求优雅的强迫症患者看着很不爽&#xff0c;查了很多网上的…

深度强化学习——蒙特卡洛算法(6)

注&#xff1a;本章的内容作为补充插曲&#xff0c;大家可以选看&#xff0c;不过还是建议把最后一个使用蒙特卡洛近似求期望稍微看一下 蒙特卡洛是一大堆随机算法&#xff0c;通过随机样本来估算真实值 使用随机样本来近似Π 1、在[a,b]做随机均匀抽样&#xff0c;抽出n个样…

软件工程开发文档写作教程(02)—开发文档的分类

版权声明 本文原创作者&#xff1a;谷哥的小弟作者博客地址&#xff1a;http://blog.csdn.net/lfdfhl本文参考资料&#xff1a;电子工业出版社《软件文档写作教程》 马平&#xff0c;黄冬梅编著 开发文档分类概述 软件项目实施过程中依据功能和作用的不同可以把文档分为以下几…

通过Python的filestools库给图片添加全图水印

文章目录 前言一、filestools库简介二、安装filestools三、查看filestools版本四、图片添加全图水印1.引入库2.添加水印3.效果 五、参数调整对比1.水印颜色1.1通过名称设置颜色1.2通过RGB值设置颜色1.3通过十六进制设置颜色 2.水印字体的大小3.水印的透明度4.水印直接的间隔5.水…

图像工程课堂记录

文章目录 图像工程0. 介绍0.1 数字图像处理0.2 数字图像分析0.3 数字图像理解 1. 概述1.1 图像的概念1.2 图像的特点1.3 数字图像的概念1.3.1 模拟图像1.3.2 数字图像1.3.3 像素 1.4 数字图像的分类1.5 数字图像的应用领域1.6 图像工程1.7 数字图像技术研究内容1.7.1 图像获取1…

如何构建超现实元宇宙空间

元宇宙是运用数字技术构建的&#xff0c;由现实世界映射或超越现实世界&#xff0c;可与现实世界交互的住自世界&#xff0c;具备新型社会体系的数字生活空间。元宇宙通过扩展现实技术提供沉浸式体验&#xff0c;基于数字孪生技术生成现实世界的镜像&#xff0c;是区块链技术搭…

【数学建模】状态转移模型的理解与应用

文章目录 初识状态转移模型&#xff1a;人狼羊菜渡河问题状态转移模型的结论状态转移模型的应用&#xff1a;n人过桥问题 直接讲理论不太容易懂&#xff0c;所以我们通过一个例子来具体讲解一下这个模型 初识状态转移模型&#xff1a;人狼羊菜渡河问题 人狼羊菜问题应该是很经…

理解FPGA的基础知识——同步电路设计

同步电路设计将系统状态的变化与时钟信号同步&#xff0c;并通过这种理想化的方式降低电路设计难度。同步电路设计是 FPGA 设计的基础。 触发器 触发器&#xff08;Flip Flop&#xff0c;FF&#xff09;是一种只能存储1个二进制位&#xff08;bit&#xff0c;比特&#xff09;…

​如何实现一个工业级哈希表​

1、避免散列表碰撞攻击 在极端情况下&#xff0c;攻击者通过精心构造的数据&#xff0c;使得所有的数据都散列到同一个槽里&#xff0c;如果使用链表冲突解决方法&#xff0c;散列表就会退化为链表&#xff0c;查询时间复杂度就从 O(1) 退化为 O(n)。 可能因为查询操作消耗大量…

Qt 制作小程序登录系统(超详细)

在这里我使用的是 Qt4, 在 windows 平台上来实现的。 文章目录 前言一、基本部件的创建二、主界面的绘制&#xff1a;1. 设置各部件文本&#xff1a;2. 界面布局&#xff1a; 三、 信号处理机制四、Qt4 显示汉字:1. 出现乱码现象2. 解决方法 五、设置标题栏的小图标总结 前言 …

C++入门(中篇)

&#x1f525;&#x1f525;本章重内容 C入门 1. 函数重载C是怎么支持函数名重载的呢&#xff1f; 2.引用2.1引用特性2.2常引用2.3使用场景1. 做参数2. 做返回值 2.4引用和指针的区别 3.内联函数 1. 函数重载 函数重载&#xff1a;是函数的一种特殊情况&#xff0c;C允许在同…

安卓手机(微信小程序)抓蓝牙通信数据包

前言 因为公司需要......所以我就弄了一下,参考了很多别人的文章。 成果:它可以抓取微信小程序、安卓APP的蓝牙数据通信包。 开始 我是小米手机,所以我以我自己手机为例 通信过程操作 第一步 打开开发者选项,打开蓝牙调试日志和蓝牙数据包日志开关(如果两者只有其中…

电动汽车路径规划问题(Electric Vehicle-Routing Problem, EVRP)

今天给大家带来的是电动汽车路径规划问题(Electric Vehicle-Routing Problem, EVRP)的介绍&#xff0c;按照惯例先上目录&#xff0c;其中第三部分的主要内容出自文献“The Electric Vehicle-Routing Problem with Time Windows and Recharging Stations”。 目录 问题简介 …

Ceph入门都精通-设备类型都是hdd ssd设置错误

手动设置class [rootceph02 ~]# ceph osd crush rm-device-class osd.0 osd.1 osd.2 done removing class of osd(s): 0,1,2 [rootceph02 ~]# ceph osd crush set-device-class ssd osd.0 osd.1 osd.2 osd.3 Error EBUSY: osd.3 has already bound to class hdd, can not res…

【LeetCode】416. 分割等和子集

416. 分割等和子集&#xff08;中等&#xff09; 方法一&#xff1a; 0-1背包问题的普通解法 思路 首先&#xff0c;对题目做一个等价转换&#xff1a; 「是否可以从数组中选择一些正整数&#xff0c;使这些数的和等于整个数组元素和的一半」。 这样就可以看作一个 0-1背包问题…

【CAN总线】CAN驱动程序分析

文章目录 一.CAN介绍二.CAN的特点二.CAN的错误检测三.OSI七层模型 一.CAN介绍 CAN具有很高的可靠性&#xff0c;广泛应用于&#xff1a;汽车电子&#xff0c;工业自动化&#xff0c;船舶&#xff0c;医疗设备&#xff0c;工业设备等方面。 当只有2个设备,简单通信,可以看成US…

【GoodERP专题】第一章 GoodERP应用专题之good_expense 费用报销 的使用

文章目录 一、模块设计二、模块1.主数据2.费用申请单3.借款单【付款】4.费用报销单【挂账/付款】5.出差申请单6.出差借款单【付款】7.差旅费报销单【挂账/付款】 总结 一、模块设计 费用报销模块是基于GoodERP框架设计的&#xff0c;该模块是为了解决企业内外费用相关报销任务处…

设计模式:结构型模式 - 装饰者模式

文章目录 1.概述2.结构3.案例4.使用场景5.JDK源码解析6.代理和装饰者的区别 1.概述 我们先来看一个快餐店的例子。 快餐店有炒面、炒饭这些快餐&#xff0c;可以额外附加鸡蛋、火腿、培根这些配菜&#xff0c;当然加配菜需要额外加钱&#xff0c;每个配菜的价钱通常不太一样&…

Tars-Cpp 协程实现分析

作者&#xff1a;vivo 互联网服务器团队- Ye Feng 本文介绍了协程的概念&#xff0c;并讨论了 Tars Cpp 协程的实现原理和源码分析。 一、前言 Tars 是 Linux 基金会的开源项目&#xff08;THE TARS FOUNDATION PROJECTS GitHub&#xff09;&#xff0c;它是基于名字服务使用…