优雅编程,从空格、空行、缩进、注释开始

这篇具有很好参考价值的文章主要介绍了优雅编程,从空格、空行、缩进、注释开始。希望对大家有所帮助。如果存在错误或未考虑完全的地方,请大家不吝赐教,您也可以点击"举报违法"按钮提交疑问。

优雅编程,从空格、空行、缩进、注释开始

很多初学者的代码其实都不够“漂亮”,那是因为没有养成好的编码习惯。本篇博客以C语言为例,总结一些好习惯。其实,很多习惯都是肌肉记忆,举个例子:请你写一个程序,输入2个整数并输出它们的和。有些朋友可能写出来是这个样子。

#include<stdio.h>
int main()
{
	int a=0;
	int b=0;
	int sum=0;
	scanf("%d%d",&a,&b);
	sum=a+b;
	printf("%d\n",sum);
	return 0;
}

我写这段代码,是在模仿有些朋友在初学的时候容易写成的样子。更有甚者,写成这个样子:

#include<stdio.h>
int main()
{
int a=0;
int b=0;
int sum=0;
scanf("%d%d",&a,&b);
sum=a+b;
printf("%d\n",sum);
return 0;
}

让人看的不太舒服。甚至可以让你更加不舒服:

#include<stdio.h>
int main()
{
int a,b,sum;scanf("%d%d",&a,&b);
sum=a+b;printf("%d\n",sum);
return 0;
}

这是什么感觉?嗯……你为啥不都写在一行呢?下面我来谈谈好的写法是怎样的。

空格

首先改进一下第一种写法,先加一些空格:

#include <stdio.h>
int main()
{
	int a = 0;
	int b = 0;
	int sum = 0;
	scanf("%d %d", &a, &b);
	sum = a + b;
	printf("%d\n", sum);
	return 0;
}

我在#include和头文件之间、“双目操作符”两端、逗号后面、scanf的两个%d之间都加上了空格,感觉舒服一点了。这就是今天我要说的第一个习惯:在合适的地方添加空格!

什么是合适的地方呢?双目操作符两端,逗号后面,分号后面,关键字后面都可以添加空格。比如经典的for循环,糟糕的写法是:

for(int i=0;i<10;++i)
{}

首先,for作为关键字,后面可以添加空格,分号后面也可以添加空格,如下:

for (int i=0; i<10; ++i)
{}

等号和小于号属于双目操作符,两端也可以添加空格:

for (int i = 0; i < 10; ++i)
{}

这样是不是好看多了?

注意:++是单目操作符,++和i之间不要添加空格,多余的空格显得画蛇添足,多此一举。

空行

除此之外,可以在合适的地方添加空行,比如函数和函数之间,函数内部不同逻辑的代码之间。比如:

void test1()
{
	printf("test1\n");
}

void test2()
{
	printf("test2\n");
}

void test3()
{
	printf("test3\n");
}

前面的例子中,头文件的包含和main函数之间可以添加空行。在main函数内部,变量的定义,输入值并且计算输出,main函数的返回属于不同的逻辑,中间可以添加空行。

#include <stdio.h>

int main()
{
	int a = 0;
	int b = 0;
	int sum = 0;
	
	scanf("%d %d", &a, &b);
	sum = a + b;
	printf("%d\n", sum);
	
	return 0;
}

缩进

顺带一提,“缩进”也很重要。大括号内部的逻辑都要向右缩进,比如:

if (flag)
{
	printf("true\n");
}

当然,如果省略大括号的情况,也要缩进。

if (flag)
	printf("true\n");

过多的缩进也不好。比如switch case语句中,case一般和switch的大括号对齐,而不缩进。

switch (n)
{
case 1:
	printf("1\n");
	break;
case 2:
	printf("2\n");
	break;
default:
	printf("default\n");
	break;
}

自然,在前面的例子中,main函数内部的语句都要添加缩进。

注释

还有最后一点:记得写注释!注释是用来解释代码的,要放在解释的代码的上边或右边,比如:

#include <stdio.h>

int main()
{
	// 定义变量
	int a = 0;
	int b = 0;
	int sum = 0; // 存放和
	// 输入数据
	scanf("%d %d", &a, &b);
	// 计算
	sum = a + b;
	// 输出数据
	printf("%d\n", sum); // 输出后换行
	
	return 0;
}

如果注释在单独的一行,可以认为这一行是一个“空行”,就不用添加额外的空行了。当然,你想添加也行,比如:

#include <stdio.h>

int main()
{
	// 定义变量
	int a = 0;
	int b = 0;
	int sum = 0; // 存放和
	
	// 输入数据
	scanf("%d %d", &a, &b);
	
	// 计算
	sum = a + b;
	
	// 输出数据
	printf("%d\n", sum); // 输出后换行
	
	return 0;
}

总结

  1. 双目操作符两端,逗号后面,分号后面,关键字后面都可以添加空格。
  2. 函数和函数之间,函数内部不同逻辑的代码之间可以添加空行。
  3. 大括号内部的逻辑都要向右缩进,但是过多的缩进也不好。
  4. 添加注释,注释是用来解释代码的。

感谢大家的阅读!文章来源地址https://www.toymoban.com/news/detail-433138.html

到了这里,关于优雅编程,从空格、空行、缩进、注释开始的文章就介绍完了。如果您还想了解更多内容,请在右上角搜索TOY模板网以前的文章或继续浏览下面的相关文章,希望大家以后多多支持TOY模板网!

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处: 如若内容造成侵权/违法违规/事实不符,请点击违法举报进行投诉反馈,一经查实,立即删除!

领支付宝红包 赞助服务器费用

相关文章

  • Git统计代码行数;Java实现统计代码行数,忽略空行、注释行

    某天,产品叫我算下某个项目的代码行数,我一愣,这怎么统计?总不可能一个文件一个文件算吧?后面我找了下,git是可以统计提交到仓库的所有的代码的,不过有个问题,就是假如有些文件我不想算进去怎么办?之后我再查了下,可以只统计指定文件类型的代码的。 在指

    2024年02月02日
    浏览(49)
  • Goland 注释时自动在注释符号后添加空格

    不得不说 JetBrains 旗下的 IDE 都好用,而且对于注释这块,使用 Ctrl + / 进行注释的时候,大多会在每个注释符号后统一添加一个空格,比如 PyCharm 和 RubeMine 等。 但最近终于碰到了一个例外,那就是 GoLand,你进行行注释的时候,它默认是不会加空格的,就像下边这种(至于它

    2024年02月12日
    浏览(39)
  • 【100天精通python】Day2:python入门_ python的语言基础,编码规范,代码注释,缩进,保留字,标识符

    目录  1 编码规范 1.1 编码规范准则 1.2 编码规范示例 2  代码注释 3  缩进

    2024年02月13日
    浏览(57)
  • vim 编辑器如何同时注释多行以及将多行进行空格

    一、场景 YAML文件对空格的要求非常严格,因此在修改YAML时,我们可能需要批量添加空格。 二、操作步骤 请注意:您的所有操作都将以第一行为基准。也就是说,第一行有多少个空格,下面的行就会模仿添加相同数量的空格。 例如: 假设我们希望123,456,000这几行都添加两

    2024年01月19日
    浏览(53)
  • SpringBoot基于Aop优雅的处理参数中的空格(提供Gitee源码)

    前言:在实际开发中,很多用户会不经意的输入空格,导致存入数据库中的信息也同样存在空格,这样会导致根据某个字段去查询数据的时候总是查询不到的问题,后来才发现是因为多了个空格的问题,如果我们按传统的方式在每个方法中一个个对空格进行处理,这样会导致

    2024年02月20日
    浏览(32)
  • 【SQL注入】靶场SQLI DUMB SERIES-26空格和注释被过滤

    26题提示所有的空格和注释都会被过滤掉 输入 ?id=0\\\' 判断闭合方式,回显报错可以确定闭合方式为单引号 正常思路是需要通过注释符将后面的语句注释掉,但是这一关的注释符被过滤了,可以考虑使用将后面的语句也闭合的思路来避免引号带来的报错。输入?id=0’\\\'发现不报错

    2024年02月22日
    浏览(38)
  • IDEA优雅自动生成类注释和快捷键生成方法注释

    Preferences - Editor - File and Code Templates - Includes - File Header 注释模板: 查看IDEA自动配置java快捷键 Preferences - Editor - Live Template - java 手动新增添加Group 描述:如下图,我手动添加了 MyGroup 分组 字段注释 操作步骤如下 添加 Live Template 添加 Abbreviation (快捷键)和 Description (描述)

    2024年02月06日
    浏览(69)
  • VS Code 一键删除所有注释,仨健格式化全部代码,一键去除行尾空格空白

    1. 打开VSCode的替换页面,快捷键为: Ctl + H 2. 鼠标左击使能正则表达式选项,快捷键为: Alt + R 3. 瞄准全部注释的正则表达式为:       4. 替换的内容什么都不写, 鼠标左击替换全部, 快捷键为: Ctl + Alt + Enter 5. 如果想删除全部空行,瞄准全部空行的正则表达式为: 同样用空来替换全

    2024年02月03日
    浏览(56)
  • IntelliJ IDEA 如何优雅的添加文档注释(附详细图解)

    在开发过程中,最常用的注释有两种: 类注释 和 方法注释 ,分别是为类和方法添加作者、日期、版本号、描述等一系列信息,增强代码的可读性,保证代码的可维护性,但通常一个项目中有数不清的类和方法,手动添加未免过于繁杂,如何 有效、便捷 地添加注释呢? ✨类

    2024年02月13日
    浏览(55)
  • chatgpt赋能python:Title:Python编程中的空格怎么用?详细教程!

    Title: Python编程中的空格怎么用?详细教程! Introduction: Python编程的空格使用一直是令人困惑的话题之一,但它却是Python语言中非常重要的一部分。空格在Python程序中用来表示代码块的开始和结束,因此不同的空格使用方式可能会导致程序运行结果的不同。所以,对于Python程序

    2024年02月11日
    浏览(43)

觉得文章有用就打赏一下文章作者

支付宝扫一扫打赏

博客赞助

微信扫一扫打赏

请作者喝杯咖啡吧~博客赞助

支付宝扫一扫领取红包,优惠每天领

二维码1

领取红包

二维码2

领红包