程序员有哪些约定俗成的“码德”?

简介: 工作中,你是否遇到过不守“码徳”的程序员,他们的代码从来不讲究规范性。比如不规范命名,直接用a、b、c等字母来命名,回溯代码总会一头雾水;比如调用API时,不讲究入参结构一致,出参结构一致,在编写调用API的SDK时,麻烦重重。本期就来讨论下,程序员有哪些约定俗称的“码徳”。

1、程序员有哪些约定俗成的“码徳”?

接口的抽象定义:

在写代码之前需要进行功能设计、详细设计,这个时候就要面向接口编程,把功能抽象为具体的接口。请求参数与响应参数的数据接口是约定好的,这样别人在阅读这段代码的时候就比较清楚;

注释清晰明确:

每个类都要进行清晰的代码注释,比如说该类的功能是什么、谁写的代码、时间等等。这个都是项目小组约定俗称的,也是程序员要遵守的;一旦该功能被其他人维护的时候,就能快速的明白该类的什么、实现了什么样的功能;

代码规范:

定义变量、方法名称的定义一定不能随意的命名,明令禁止的是魔法值的定义,比如说,定义了一个变量a、变量b、变量c这类定义是不允许的;方法的长度限制,如果一个函数有5000行代码,那么这个代码可以说是代码中的“屎山”,又臭又长,没有人能够维护的,还有就是一些功能使用的规范了,这个可以参考阿里巴巴的代码规范;

代码的具体实现逻辑清晰:

代码的逻辑,代码有两种逻辑,一种是业务逻辑,这种逻辑是真正的业务处理逻辑;另外一种是控制逻辑,这种逻辑只是控制程序流转的,比如说异步控制、控制变量、多线程处理等等;这两种逻辑要分开,很多代码之所以混乱就是这两种逻辑糅合在了一起导致的。


2、你觉得哪些不规范的编程行为最让人头疼?

命名规范的问题:

代码中的变量随意的进行命名,一些命名完全看不到定义的作用是什么,比如说一个变量a、变量b、变量c,最后进行这两个变量的计算;

代码长度的问题:

一个接口的实现方法超过了500行,就很难让人读懂了。如果一个代码过长的话,就很让人有读下去的想法,也很难维护,看别人的代码能让人看吐,这个真不是说说的;

逻辑流水账的写法:

一个代码的好坏,通过接口就能看出来,这个业务的功能大概有多少;接口的划分很重要,单一原则,依赖倒置原则、开闭原则这些都是开发者的宝典,要反复的阅读;如果一个功能就两个方法,每个方法内实现了多个功能就很有问题了,这些就违反了设计原则。这个也是程序员最应该遵守的。


最后:

推荐阅读,23种设计模式、代码的坏味道,程序员的自我修养。希望每个人不仅仅是码农,也能是工程师,不仅仅会写增删改查,也能做大型工业软件的核心功能逻辑;定义规范、写出好的代码,人人为我,我为人人。


目录
打赏
0
1
1
0
522
分享
相关文章
优秀的程序员,必须知道的
昨天看到一则新闻,一对夫妻起诉一家婚庆公司,缘由是这家婚庆公司盗用了他们的婚庆典礼创意,最终取得了胜诉 这不禁让我想到,作为程序员,代码就是我们的产品,应该如何保护自己的权益, 另外版权对我们来说已经是绕不开的话题了,特别是游戏 APP 的开发者,必须具有软件著作权才能发布 那么今天我们就聊一聊关于版权的那些事儿吧
190 0
优秀的程序员,必须知道的
厉害了,天刚一冷程序员就都换上了衬衫。。
这才农历九月初,大秋天的,深圳的天气就已经降温了。更搞笑的是,朋友圈、群里都在转发下面这张图片,相信大部分人已经看过了吧
厉害了,天刚一冷程序员就都换上了衬衫。。
水瓶座的回顾-高贵的程序员
水瓶座的回顾-高贵的程序员
124 0
作为一个程序员,如何保持优秀
作为一个程序员,如何保持优秀
137 0
为什么要选择做一名程序员?
从这篇文章开始准备做一个大学生学编程系列文章,主要帮助一些还在编程路上徘徊的小伙伴,作为一个过来人的身份总结一些编程经验以及心得,在自学的过程中走了很多的弯路,在此通过这个专栏分享给需要编程的小伙伴。
2104 1
为什么越来越多的人不愿意做程序员?
为什么越来越多的人不愿意做程序员?
3161 0