知识屋:更实用的电脑技术知识网站
所在位置:首页 > 科技

代码编写行为准则,编码是一个认真思考的过程,如何有效提高代码的可读性?

发表时间:2022-03-25来源:网络

编写代码,实质是在梳理逻辑,为了完善整个逻辑流程,我们借用编程语言的变量、函数、流程控制、循环、注释、方法等串接起来,完善一套系统的逻辑。

为了完善这套逻辑,我们借助了许多工具:设计方法、架构设计、项目组织等。

意识到没有,代码的好坏一定程度上可以从逻辑层面评判。

符合逻辑,不一定是最优的代码不符合逻辑,一定不是好的代码

从这层面来看,梳理逻辑极为重要,逻辑通了,剩下的就是实现了。

逻辑的串接靠的是编程语言的变量、函数、流程控制、循环、注释等。

本文从这些层面讲述,如何编写可读代码。

 

小编推荐一个学C语言/C++的学习裙【  712,284,705】,无论你是大牛还是小白,是想转行还是想入行都可以来了解一起进步一起学习!裙内有开发工具,很多干货和技术资料分享!

 

0. 规范

绝大多数的人,不会从零完整的完成一个复杂的项目,大多是团队共同合作,完成一个大的项目。

这个时候,假如你是中途参与进来。你在实现逻辑的时候,你是照着自己的逻辑来还是依照团队的风格来。

比如项目组织,命名等...

依照团队的风格来

尤其针对复杂的上线的项目,完整的理解整个项目都存在困难,这个时候,风格统一尤其重要。

是的,这个时候,风格一致性重要,当然具体的实现逻辑,还是应该遵从易于理解这个大方向。

1. 编程语言规范

准则:坚持编程语言的风格

每门编程语言,都存在一定的规范,这个时候,编程语言的整体规范需要遵从。

大家可能会多参考 google 出品的各种编程语言规范。方向没错。

2. 命名

变量函数方法

准则:易于理解

如何做到易于理解:

专业的单词:使用领域内的单词避免空泛的名字具体的名字变量名带上更多细节不使用令人误解的名字布尔值命名不建议使用的单词

2.1 领域内的单词

这个和项目相关,比如系统是个智慧零售后台,那么领域内单词多是:顾客、商品、商铺、店员、店长、价格等。

customerproduceshopshopLeaderprice

2.2 避免空泛的名字

变量的命名一般要赋予一定的意义,极少情况下可以使用没有什么意义的单词。比如最常见的:

var ( numberOne int temp int numberTwo int ) tmp = numberOne numberOne = numberTwo numberTwo = tmp

再比如:

var i int for i=0;i= 2 * number_processors, that is good enough.

好,假如你正在优化代码,看到这注释,是的,你知道该如何调整了。

全局注释

一般在文件开头,表明文件内代码完成的任务。

总结性注释

一般函数开头,表明函数代码完成的任务。

其他

润色语句。言简意赅由于冗长的解释。

 

以上就是代码表面整洁规范的标准和建议,希望大家都能敲出高效、整洁的代码。

 

如果你也想要自学C语言,接受全面系统的指导。

这里有一个交流群推荐给你。不论是小白还是进阶者,在这里都能获得成长。群内含有,学习书籍电子书资源,素材包,还有免费教学课程哦~ 点我进入群聊

 

收藏
  • 人气文章
  • 最新文章
  • 下载排行榜
  • 热门排行榜