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

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

相关文章

Java中的雪花算法Snowflake解析与实践技巧

《Java中的雪花算法Snowflake解析与实践技巧》本文解析了雪花算法的原理、Java实现及生产实践,涵盖ID结构、位运算技巧、时钟回拨处理、WorkerId分配等关键点,并探讨了百度UidGen... 目录一、雪花算法核心原理1.1 算法起源1.2 ID结构详解1.3 核心特性二、Java实现解析2.

Java中调用数据库存储过程的示例代码

《Java中调用数据库存储过程的示例代码》本文介绍Java通过JDBC调用数据库存储过程的方法,涵盖参数类型、执行步骤及数据库差异,需注意异常处理与资源管理,以优化性能并实现复杂业务逻辑,感兴趣的朋友... 目录一、存储过程概述二、Java调用存储过程的基本javascript步骤三、Java调用存储过程示

Visual Studio 2022 编译C++20代码的图文步骤

《VisualStudio2022编译C++20代码的图文步骤》在VisualStudio中启用C++20import功能,需设置语言标准为ISOC++20,开启扫描源查找模块依赖及实验性标... 默认创建Visual Studio桌面控制台项目代码包含C++20的import方法。右键项目的属性:

MySQL数据库的内嵌函数和联合查询实例代码

《MySQL数据库的内嵌函数和联合查询实例代码》联合查询是一种将多个查询结果组合在一起的方法,通常使用UNION、UNIONALL、INTERSECT和EXCEPT关键字,下面:本文主要介绍MyS... 目录一.数据库的内嵌函数1.1聚合函数COUNT([DISTINCT] expr)SUM([DISTIN

Java实现自定义table宽高的示例代码

《Java实现自定义table宽高的示例代码》在桌面应用、管理系统乃至报表工具中,表格(JTable)作为最常用的数据展示组件,不仅承载对数据的增删改查,还需要配合布局与视觉需求,而JavaSwing... 目录一、项目背景详细介绍二、项目需求详细介绍三、相关技术详细介绍四、实现思路详细介绍五、完整实现代码

Go语言代码格式化的技巧分享

《Go语言代码格式化的技巧分享》在Go语言的开发过程中,代码格式化是一个看似细微却至关重要的环节,良好的代码格式化不仅能提升代码的可读性,还能促进团队协作,减少因代码风格差异引发的问题,Go在代码格式... 目录一、Go 语言代码格式化的重要性二、Go 语言代码格式化工具:gofmt 与 go fmt(一)

HTML5实现的移动端购物车自动结算功能示例代码

《HTML5实现的移动端购物车自动结算功能示例代码》本文介绍HTML5实现移动端购物车自动结算,通过WebStorage、事件监听、DOM操作等技术,确保实时更新与数据同步,优化性能及无障碍性,提升用... 目录1. 移动端购物车自动结算概述2. 数据存储与状态保存机制2.1 浏览器端的数据存储方式2.1.

基于 HTML5 Canvas 实现图片旋转与下载功能(完整代码展示)

《基于HTML5Canvas实现图片旋转与下载功能(完整代码展示)》本文将深入剖析一段基于HTML5Canvas的代码,该代码实现了图片的旋转(90度和180度)以及旋转后图片的下载... 目录一、引言二、html 结构分析三、css 样式分析四、JavaScript 功能实现一、引言在 Web 开发中,

Python如何去除图片干扰代码示例

《Python如何去除图片干扰代码示例》图片降噪是一个广泛应用于图像处理的技术,可以提高图像质量和相关应用的效果,:本文主要介绍Python如何去除图片干扰的相关资料,文中通过代码介绍的非常详细,... 目录一、噪声去除1. 高斯噪声(像素值正态分布扰动)2. 椒盐噪声(随机黑白像素点)3. 复杂噪声(如伪

Java Spring ApplicationEvent 代码示例解析

《JavaSpringApplicationEvent代码示例解析》本文解析了Spring事件机制,涵盖核心概念(发布-订阅/观察者模式)、代码实现(事件定义、发布、监听)及高级应用(异步处理、... 目录一、Spring 事件机制核心概念1. 事件驱动架构模型2. 核心组件二、代码示例解析1. 事件定义