算法——让你的代码更具有可读性

2024-01-15 04:36
文章标签 算法 代码 具有 可读性

本文主要是介绍算法——让你的代码更具有可读性,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

今天其实算一个小专栏(内容参考《代码大全2》)明天开始更新具体的算法,这些算法我都会从力扣上找,语言的话暂时是c和c++还有c#的写法(不要过于专注于编程语言,语言只是工具,关键在于学习思维)

一、高质量子函数

1.要有正当理由

我们创建子程序的目的,就是让主函数尽量简洁,复杂的部分放到子函数或者是一些需要反复调用的模块

只有针对以上的两种情况时,我们才会构造子函数,对于过于简单而且调用较少的部分,就完全没有必要了

所以创建子函数要有正当理由

2.要有好的名字

什么是好名字

假如有一个函数命名为abc(),你觉得这个函数要实现的功能是什么呢?

只有让人一目了然,能够清晰的知道这个函数是要干什么,有什么作用比方说:add()函数,一眼就知道这个是用来添加的(对于复杂程序可以加入一些宾语来让函数名更加清晰 例如numadd)

3.要有合适长度

这个长度是指,子函数命名不要过于繁琐,可以适当扩充使函数作用清晰的核心,永远是适当。如果太长不仅容易让自己记混而且让可读性也受制

二、变量名的注意事项

1.命名

为变量命名时最重要的考虑事项是,该名字要完全、准确地描述出该变量所代表的事物。

如果要表示当前利率的变量最好命名为 rate或 interestRate,而不是简单的r或x。甚至是a、b、c

2.缩短变量的存活时间

如果该变量在第1行被第一次引用,在第25行被最后一次引用,那么它的存活时间就是25条语句。

缩短变量存活时间的个好处是使你能对自己的代码有更准确的认识。

打个比方:如果一个变量在第10行赋值,却要到第45行才再次使用它,那么于这两个引用点之间的那一长段距离就暗示说该变量在第10行到第45行的范围内一直在使用。如果该变量是在第44行赋值,在第45行使用,那么不会有任何有关该变量使用的暗示产生,你在思考这个变量的时候也就能集中于更小范围的代码了。

三、进行合理的缩进处理

如果缺少了适当的缩进,对于下面代码而言

# include<stdio.h>
int main()
{
int n, i, j;
printf("请输入正方形的边长:\n");
scanf("%d",&n);
for(i = 1;i<=n;i++){
for(j = 1;j<=n;j++){
if(i == 1||i == n)
{printf("* "); }else{if(j == 1 || j == n){printf("* ");}else{
printf("  ");}}}
printf("\n");}
return 0;}

很难想象下面的代码和上面的是同一个


# include<stdio.h>
int main()
{int n, i, j;printf("请输入正方形的边长:\n");scanf("%d",&n);for(i = 1;i<=n;i++){for(j = 1;j<=n;j++){if(i == 1||i == n){printf("* "); }else{if(j == 1 || j == n){printf("* ");}else{printf("  ");}}}printf("\n");}return 0;
}
  1. 对于内部的嵌套尽量放到下一级(扩大缩进)

  2. 对于不同的部分要有合适的留白行来进行区分

END

这篇关于算法——让你的代码更具有可读性的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/607660

相关文章

python实现pdf转word和excel的示例代码

《python实现pdf转word和excel的示例代码》本文主要介绍了python实现pdf转word和excel的示例代码,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价... 目录一、引言二、python编程1,PDF转Word2,PDF转Excel三、前端页面效果展示总结一

在MyBatis的XML映射文件中<trim>元素所有场景下的完整使用示例代码

《在MyBatis的XML映射文件中<trim>元素所有场景下的完整使用示例代码》在MyBatis的XML映射文件中,trim元素用于动态添加SQL语句的一部分,处理前缀、后缀及多余的逗号或连接符,示... 在MyBATis的XML映射文件中,<trim>元素用于动态地添加SQL语句的一部分,例如SET或W

使用C#代码计算数学表达式实例

《使用C#代码计算数学表达式实例》这段文字主要讲述了如何使用C#语言来计算数学表达式,该程序通过使用Dictionary保存变量,定义了运算符优先级,并实现了EvaluateExpression方法来... 目录C#代码计算数学表达式该方法很长,因此我将分段描述下面的代码片段显示了下一步以下代码显示该方法如

Python中的随机森林算法与实战

《Python中的随机森林算法与实战》本文详细介绍了随机森林算法,包括其原理、实现步骤、分类和回归案例,并讨论了其优点和缺点,通过面向对象编程实现了一个简单的随机森林模型,并应用于鸢尾花分类和波士顿房... 目录1、随机森林算法概述2、随机森林的原理3、实现步骤4、分类案例:使用随机森林预测鸢尾花品种4.1

python多进程实现数据共享的示例代码

《python多进程实现数据共享的示例代码》本文介绍了Python中多进程实现数据共享的方法,包括使用multiprocessing模块和manager模块这两种方法,具有一定的参考价值,感兴趣的可以... 目录背景进程、进程创建进程间通信 进程间共享数据共享list实践背景 安卓ui自动化框架,使用的是

SpringBoot生成和操作PDF的代码详解

《SpringBoot生成和操作PDF的代码详解》本文主要介绍了在SpringBoot项目下,通过代码和操作步骤,详细的介绍了如何操作PDF,希望可以帮助到准备通过JAVA操作PDF的你,项目框架用的... 目录本文简介PDF文件简介代码实现PDF操作基于PDF模板生成,并下载完全基于代码生成,并保存合并P

SpringBoot基于MyBatis-Plus实现Lambda Query查询的示例代码

《SpringBoot基于MyBatis-Plus实现LambdaQuery查询的示例代码》MyBatis-Plus是MyBatis的增强工具,简化了数据库操作,并提高了开发效率,它提供了多种查询方... 目录引言基础环境配置依赖配置(Maven)application.yml 配置表结构设计demo_st

SpringCloud集成AlloyDB的示例代码

《SpringCloud集成AlloyDB的示例代码》AlloyDB是GoogleCloud提供的一种高度可扩展、强性能的关系型数据库服务,它兼容PostgreSQL,并提供了更快的查询性能... 目录1.AlloyDBjavascript是什么?AlloyDB 的工作原理2.搭建测试环境3.代码工程1.

Java调用Python代码的几种方法小结

《Java调用Python代码的几种方法小结》Python语言有丰富的系统管理、数据处理、统计类软件包,因此从java应用中调用Python代码的需求很常见、实用,本文介绍几种方法从java调用Pyt... 目录引言Java core使用ProcessBuilder使用Java脚本引擎总结引言python

Java中ArrayList的8种浅拷贝方式示例代码

《Java中ArrayList的8种浅拷贝方式示例代码》:本文主要介绍Java中ArrayList的8种浅拷贝方式的相关资料,讲解了Java中ArrayList的浅拷贝概念,并详细分享了八种实现浅... 目录引言什么是浅拷贝?ArrayList 浅拷贝的重要性方法一:使用构造函数方法二:使用 addAll(