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

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

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

接口的抽象定义:

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

注释清晰明确:

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

代码规范:

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

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

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


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

命名规范的问题:

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

代码长度的问题:

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

逻辑流水账的写法:

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


最后:

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


相关文章
|
机器学习/深度学习 前端开发 Oracle
程序员的那些事
本文章介绍了程序员是做什么的要学什么
258 0
程序员的那些事
|
10月前
|
程序员 项目管理 微服务
一个程序员的思考
或许,如同传闻所说,程序员这碗饭吃的就是青春,35岁就濒临被辞的风险,甚至于说程序员已然过度饱和,不再有过多机会给予新人入圈。而面对这种现状,作为一位普通二本院校出身的学生,更是没有所谓的学历优势,不过,幸好,学历对于程序员来说并非真正看重的一点,技术力才是正确的关键词,而这,也是我喜欢程序员的理由之一。我明白,这是一个不容易的开始,但也请相信,决不会草草结束。
64 1
|
程序员 开发者
程序员日常技巧
程序员日常技巧
程序员日常技巧
|
架构师 程序员 Android开发
35岁以上程序员都去哪里了?
人这一辈子没法做太多的事情,所以每一件都要做得精彩绝伦。 你的时间有限,所以不要为别人而活。不要被教条所限,不要活在别人的观念里。不要让别人的意见左右自己内心的声音。 最重要的是,勇敢的去追随自己的心灵和直觉,只有自己的心灵和直觉才知道你自己的真实想法,其他一切都是次要。 身边好几个年轻的同事都在说房价,很多人抱怨房价太高了买不起怎么办好迷茫…
35岁以上程序员都去哪里了?
|
小程序 算法 Unix
优秀的程序员,必须知道的
昨天看到一则新闻,一对夫妻起诉一家婚庆公司,缘由是这家婚庆公司盗用了他们的婚庆典礼创意,最终取得了胜诉 这不禁让我想到,作为程序员,代码就是我们的产品,应该如何保护自己的权益, 另外版权对我们来说已经是绕不开的话题了,特别是游戏 APP 的开发者,必须具有软件著作权才能发布 那么今天我们就聊一聊关于版权的那些事儿吧
152 0
优秀的程序员,必须知道的
|
算法 Java 程序员
同样是程序员,为什么别人比你更优秀?
随着互联网时代的飞速发展,越来越多的人投身于软件开发行业,大家都称他们为程序员,或者码农。 这些程序员的水平也是参差不齐的,有些人从比较好的学校毕业,水平却一般般;也有些人从一般搬的学校毕业,但是水平很高,因为他们付出了比其他人更多的努力;也有些人,不管是好学校还是差学校,毕业了都跑去培训班培训了,出来的也是良莠不齐的。
1160 0
|
架构师 程序员
如果我告诉你,程序员这条路很难走,你还要坚持走下去吗
可能很多人都觉得程序员是个高薪行业,动不动就听见谁月薪几万几万,心里羡慕不已。回头看自己每个月手里可怜的工资条,心里更是烦躁不已,于是乎下定决心一定要像人家一样,月薪几万。
1736 0
|
程序员 C# 数据库
成为一个程序员的准备
1、 程序员意味着要编程序。(如果你仅仅想得到一份高薪水的工作,喝喝咖啡就等老板发薪水,我奉劝你还是另找一份更合适的工作,譬如练摊,真的,兄弟,这份工作不适合你) 2、你是学文的还是学理的,编程序也许需要浪漫,但更需要逻辑和严谨。
1356 0
|
程序员 PHP
来自一个程序员的内心世界
一入编程深似海,从此再无双休日.在我们行当一直有这么一个民间歌谣。程序猿很辛苦,这是必然的.路漫漫其修远兮,吾将上下而求索。天将降大任于斯人也,必先苦其心志,劳其筋骨,饿其体肤,空乏其身。
1514 0
|
程序员
为什么要选择做一名程序员?
从这篇文章开始准备做一个大学生学编程系列文章,主要帮助一些还在编程路上徘徊的小伙伴,作为一个过来人的身份总结一些编程经验以及心得,在自学的过程中走了很多的弯路,在此通过这个专栏分享给需要编程的小伙伴。
2036 0

相关实验场景

更多