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

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

相关文章

使用Redis实现会话管理的示例代码

《使用Redis实现会话管理的示例代码》文章介绍了如何使用Redis实现会话管理,包括会话的创建、读取、更新和删除操作,通过设置会话超时时间并重置,可以确保会话在用户持续活动期间不会过期,此外,展示了... 目录1. 会话管理的基本概念2. 使用Redis实现会话管理2.1 引入依赖2.2 会话管理基本操作

mybatis-plus分表实现案例(附示例代码)

《mybatis-plus分表实现案例(附示例代码)》MyBatis-Plus是一个MyBatis的增强工具,在MyBatis的基础上只做增强不做改变,为简化开发、提高效率而生,:本文主要介绍my... 目录文档说明数据库水平分表思路1. 为什么要水平分表2. 核心设计要点3.基于数据库水平分表注意事项示例

Nginx服务器部署详细代码实例

《Nginx服务器部署详细代码实例》Nginx是一个高性能的HTTP和反向代理web服务器,同时也提供了IMAP/POP3/SMTP服务,:本文主要介绍Nginx服务器部署的相关资料,文中通过代码... 目录Nginx 服务器SSL/TLS 配置动态脚本反向代理总结Nginx 服务器Nginx是一个‌高性

HTML5的input标签的`type`属性值详解和代码示例

《HTML5的input标签的`type`属性值详解和代码示例》HTML5的`input`标签提供了多种`type`属性值,用于创建不同类型的输入控件,满足用户输入的多样化需求,从文本输入、密码输入、... 目录一、引言二、文本类输入类型2.1 text2.2 password2.3 textarea(严格

JAVA项目swing转javafx语法规则以及示例代码

《JAVA项目swing转javafx语法规则以及示例代码》:本文主要介绍JAVA项目swing转javafx语法规则以及示例代码的相关资料,文中详细讲解了主类继承、窗口创建、布局管理、控件替换、... 目录最常用的“一行换一行”速查表(直接全局替换)实际转换示例(JFramejs → JavaFX)迁移建

Go异常处理、泛型和文件操作实例代码

《Go异常处理、泛型和文件操作实例代码》Go语言的异常处理机制与传统的面向对象语言(如Java、C#)所使用的try-catch结构有所不同,它采用了自己独特的设计理念和方法,:本文主要介绍Go异... 目录一:异常处理常见的异常处理向上抛中断程序恢复程序二:泛型泛型函数泛型结构体泛型切片泛型 map三:文

MyBatis中的两种参数传递类型详解(示例代码)

《MyBatis中的两种参数传递类型详解(示例代码)》文章介绍了MyBatis中传递多个参数的两种方式,使用Map和使用@Param注解或封装POJO,Map方式适用于动态、不固定的参数,但可读性和安... 目录✅ android方式一:使用Map<String, Object>✅ 方式二:使用@Param

SpringBoot实现图形验证码的示例代码

《SpringBoot实现图形验证码的示例代码》验证码的实现方式有很多,可以由前端实现,也可以由后端进行实现,也有很多的插件和工具包可以使用,在这里,我们使用Hutool提供的小工具实现,本文介绍Sp... 目录项目创建前端代码实现约定前后端交互接口需求分析接口定义Hutool工具实现服务器端代码引入依赖获

利用Python在万圣节实现比心弹窗告白代码

《利用Python在万圣节实现比心弹窗告白代码》:本文主要介绍关于利用Python在万圣节实现比心弹窗告白代码的相关资料,每个弹窗会显示一条温馨提示,程序通过参数方程绘制爱心形状,并使用多线程技术... 目录前言效果预览要点1. 爱心曲线方程2. 显示温馨弹窗函数(详细拆解)2.1 函数定义和延迟机制2.2

Springmvc常用的注解代码示例

《Springmvc常用的注解代码示例》本文介绍了SpringMVC中常用的控制器和请求映射注解,包括@Controller、@RequestMapping等,以及请求参数绑定注解,如@Request... 目录一、控制器与请求映射注解二、请求参数绑定注解三、其他常用注解(扩展)四、注解使用注意事项一、控制