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

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

相关文章

springboot循环依赖问题案例代码及解决办法

《springboot循环依赖问题案例代码及解决办法》在SpringBoot中,如果两个或多个Bean之间存在循环依赖(即BeanA依赖BeanB,而BeanB又依赖BeanA),会导致Spring的... 目录1. 什么是循环依赖?2. 循环依赖的场景案例3. 解决循环依赖的常见方法方法 1:使用 @La

使用C#代码在PDF文档中添加、删除和替换图片

《使用C#代码在PDF文档中添加、删除和替换图片》在当今数字化文档处理场景中,动态操作PDF文档中的图像已成为企业级应用开发的核心需求之一,本文将介绍如何在.NET平台使用C#代码在PDF文档中添加、... 目录引言用C#添加图片到PDF文档用C#删除PDF文档中的图片用C#替换PDF文档中的图片引言在当

C#使用SQLite进行大数据量高效处理的代码示例

《C#使用SQLite进行大数据量高效处理的代码示例》在软件开发中,高效处理大数据量是一个常见且具有挑战性的任务,SQLite因其零配置、嵌入式、跨平台的特性,成为许多开发者的首选数据库,本文将深入探... 目录前言准备工作数据实体核心技术批量插入:从乌龟到猎豹的蜕变分页查询:加载百万数据异步处理:拒绝界面

用js控制视频播放进度基本示例代码

《用js控制视频播放进度基本示例代码》写前端的时候,很多的时候是需要支持要网页视频播放的功能,下面这篇文章主要给大家介绍了关于用js控制视频播放进度的相关资料,文中通过代码介绍的非常详细,需要的朋友可... 目录前言html部分:JavaScript部分:注意:总结前言在javascript中控制视频播放

Spring Boot 3.4.3 基于 Spring WebFlux 实现 SSE 功能(代码示例)

《SpringBoot3.4.3基于SpringWebFlux实现SSE功能(代码示例)》SpringBoot3.4.3结合SpringWebFlux实现SSE功能,为实时数据推送提供... 目录1. SSE 简介1.1 什么是 SSE?1.2 SSE 的优点1.3 适用场景2. Spring WebFlu

java之Objects.nonNull用法代码解读

《java之Objects.nonNull用法代码解读》:本文主要介绍java之Objects.nonNull用法代码,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐... 目录Java之Objects.nonwww.chinasem.cnNull用法代码Objects.nonN

SpringBoot实现MD5加盐算法的示例代码

《SpringBoot实现MD5加盐算法的示例代码》加盐算法是一种用于增强密码安全性的技术,本文主要介绍了SpringBoot实现MD5加盐算法的示例代码,文中通过示例代码介绍的非常详细,对大家的学习... 目录一、什么是加盐算法二、如何实现加盐算法2.1 加盐算法代码实现2.2 注册页面中进行密码加盐2.

python+opencv处理颜色之将目标颜色转换实例代码

《python+opencv处理颜色之将目标颜色转换实例代码》OpenCV是一个的跨平台计算机视觉库,可以运行在Linux、Windows和MacOS操作系统上,:本文主要介绍python+ope... 目录下面是代码+ 效果 + 解释转HSV: 关于颜色总是要转HSV的掩膜再标注总结 目标:将红色的部分滤

在C#中调用Python代码的两种实现方式

《在C#中调用Python代码的两种实现方式》:本文主要介绍在C#中调用Python代码的两种实现方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录C#调用python代码的方式1. 使用 Python.NET2. 使用外部进程调用 Python 脚本总结C#调

Java时间轮调度算法的代码实现

《Java时间轮调度算法的代码实现》时间轮是一种高效的定时调度算法,主要用于管理延时任务或周期性任务,它通过一个环形数组(时间轮)和指针来实现,将大量定时任务分摊到固定的时间槽中,极大地降低了时间复杂... 目录1、简述2、时间轮的原理3. 时间轮的实现步骤3.1 定义时间槽3.2 定义时间轮3.3 使用时