首页
学习
活动
专区
工具
TVP
发布

程序员如何将自己的代码写得美观简洁,只需做的如下几点

相信很多初入门的程序员,都会苦恼那种编码风格更适合自己;如何才能使自己的代码写的既美观又简介,而不是自己写的代码,隔一个月自己看了,都厌烦。下面小编就介绍几个比较简单实用的方法。另外本文讨论的都是嵌入式C代码的编码方法,如果使用其他语言,或者是大神,那就直接忽略吧!

一、能使用大括号的地方尽量使用带括号;那么为什么呢,下面我们来看一个例子

a = b;

c = b;

else

b = a;

c = b;

上面例子可以看出忘了将c = b缩进后,可能会产生歧义;搞不清这句话到底属于if else判断语句内,还是在外面,上面的例子,if else 语句还是比较短的,如果再长一点,那们就更搞不清了。下面我们看看带上大括号的感觉,是不是层次感就特别清楚了。

{

a = b;

c = b;

}

else

{

b = a;

c = b;

}

二、缩进不要靠TAB键,尽量使用空格;这是为什么呢?这里主要考虑使用不同的代码编辑器,看同一份代码的原因。由于不同编辑器对TAB显示会有不同;有的编辑器显示TAB键为两个空格;有的TAB键会显示4个空格。这样就导致一份代码在一个编辑器上缩进非常美观,代码特别好看。但是在另一个编辑器上就是乱七八糟。而统一都使用空格缩进就没有这种问题。那么我一定要用,非常喜欢用TAB键怎么办呢。那么也是有办法的,一般编辑器都支持可以将输入TAB键的时候直接转换为空格。小编一般都是设置一个TAB键等于4个空格。具体怎么设置,每个编辑器都不同,这里就不说具体方法,需要读者自己去摸索。

三、统一的代码风格,特别是命名方法;如今比较主流的命名方法,一般是驼峰命名法、匈牙利命名法和下划线命名法,或者是几种方法的相结合,这些都没有问题。重要的是统一,一个项目所有成员都用一种命名方法,甚至一个公司都要用一种命名方法。我觉得做为一个程序员进入一个新的公司,首先就要习惯和熟悉公司的命名风格,不能再按照以前的命名习惯写代码。我以前就遇到一个同事,可能是大公司出来的比较傲气,我们同事偶尔会委婉的提一下,让他尽量把他的代码风格向公司的代码风格靠拢。可他却说,我以前在某某公司都是这样的,这种代码风格是最合适的。都这样说,我们还能说啥,只能闭嘴了。

四、尽量将使用的类型重新定义成一个,一看名字就知道作用的类型。为什么呢?C 语言只提供了char,int,long等几个类型。那么我们用这些类型定义一个变量,有时候可能不是特别明确。下面我们举个例子大家就明白了

1 int chl;

2 ADC_Chl_Type chl;

上面的代码是一个意思;那么是第一个好,还是第二个好呢?显然是第二个;可读性强很多,一看就明白这个chl变量是用来定义ADC模块的通道的。

五、数字能用宏定义的尽量使用宏定义;为什么呢?还是可读性强一定;下面举一个例子;

1 state = 0;

2 #define EE_OK 0

state = EE_OK;

怎么样是不是可读性比第一个好很多。

六、使用#ifndef #define #endif模式定义都文件,是什么意思呢?我们举一个例子,我们定义一个Adc.h头文件。

#ifndef ADC_H

#define ADC_H

/* code */

#endif /* ADC_H */

大概就是这种模式,这种模式有什么好呢?假如我这个头文件被多个文件include了,通过我上面的语句,这个同文件也只相当于include一次。

七、适量的注释,为什么说适量呢?注释太少,无法起到注释的作用,注释太多,就显得本末倒置了。

由于小编是汽车电子行业的,所以这些方法比较适合汽车电子行业,可能别的行业不是特别合适,请大家见谅。

今天就说到这里,其实还有很多,我会在后续的文章种持续更新,希望大家关注。

  • 发表于:
  • 原文链接https://kuaibao.qq.com/s/20190815A0SAOG00?refer=cp_1026
  • 腾讯「腾讯云开发者社区」是腾讯内容开放平台帐号(企鹅号)传播渠道之一,根据《腾讯内容开放平台服务协议》转载发布内容。
  • 如有侵权,请联系 cloudcommunity@tencent.com 删除。

扫码

添加站长 进交流群

领取专属 10元无门槛券

私享最新 技术干货

扫码加入开发者社群
领券