算法——让你的代码更具有可读性-Toy模板网

这篇具有很好参考价值的文章主要介绍了算法——让你的代码更具有可读性。希望对大家有所帮助。如果存在错误或未考虑完全的地方，请大家不吝赐教，您也可以点击"举报违法"按钮提交疑问。

今天其实算一个小专栏（内容参考《代码大全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;
}