本论坛注册非常方便,使用微信扫码即可注册,欢迎大家注册
程序员很多时候会谈到代码风格。当我们在一起开发的时候,统一的代码风格确实很重要。
不过,每个人都有不同的喜好,按照别人的方式写代码都会不爽,所以今天介绍一个神器,Artistic Style,自动化代码格式工具。
有了这个工具,我们可以在拿到别人的代码的时候,运行一下,将代码格式化为自己喜欢的格式。
当我们需要将代码给到别人时,运行下,将代码再格式化为大家统一的风格。
Artistic Style的官网是 http://astyle.sourceforge.net/。
下面介绍如何使用这个工具。
一、安装
AStyle的安装很简单。在windows下面,我们只需将下载的压缩包解压缩,再设置下环境变量就Ok。
二、使用
这样的工具一般是没有图形化界面的,所以设置好环境变量后,可以在cmd环境中运行。
1 - 切换到需要修改的代码的目录。
2 - 里面有hello.c文件,内容如下:
原始内容
3 - 我们运行如下命令
astyle --style=allman hello.c
会输出如下
格式化 hello.c
现在文件内容变为:
现在代码已经被格式化了,使用的是一个基础样式allman。astyle还有很多其他的样式,比如linux,kr之类的,详情请查看官方帮助文档。
但是我们可以看到,现在的代码格式还有些怪,因为基础样式,只是做了基础的处理。我们可以额外加一些参数。
4 - 使用额外参数
我们使用rtthread官方推荐的参数,
- 参数:--style=allman
- --indent=spaces=4
- --indent-preproc-block
- --pad-oper
- --pad-header
- --unpad-paren
- --suffix=none
- --align-pointer=name
- --lineend=linux
- --convert-tabs
- --verbose
复制代码
对代码进行格式化,内容会变为如下:
这已经是可以接受的代码风格啦。里面参数具体含义可以到官网查看帮助信息,或者直接就拿来使用。
三、编写成.bat脚本
每次都进入cmd还是太麻烦了,所以我们可以将命令编写到一个.bat文件中,每次双击下,自动运行就好啦。至于文件名,可以使用--recursive *.c,h这样的格式,会格式化当前目录下所有的文件。
希望大家以后都不必为格式这样的东西纠结,专注敲代码。但是代码命令风格之类的,还是需要自己注意,现在还没工具能帮你自动修改函数名。不过人工智能可能可以,哈哈哈。。。
|