astyle 是一个代码格式化工具，为 C,C++,JAVA 等语言提供代码格式化功能。
官方描述为：Artistic Style is a source code indenter, formatter, and beautifier for the C, C++, C++/CLI, Objective‑C, C# and Java programming languages.
相关页面：官方地址，文档地址，下载页面（当前最新版本位 3.1） 。
一、编译安装
安装可参考官方安装文档，提供了多种方式编译安装，这里使用 cmake 。
|
1 2 3 4 5 6 7 8 9 10 |
# 解压 tar -zxvf astyle_3.1_linux.tar.gz cd astyle # 创建编译文件夹 mkdir as-gcc-exe cd as-gcc-exe cmake .. # 编译和安装 make make install |
默认情况下，可执行文件被安装在/usr/bin，文档放在/usr/share/doc/astyle，安装完成后直接就可使用 astyle 命令。
官方并没有提供 make uninstall 卸载的功能，如需卸载需要在编译目录下执行 xargs rm < install_manifest.txt 。
二、 astyle 用法
2.1 基本用法
详细用法可参考官方文档地址，astyle 最简单的用法就是通过--style 选项指定要格式化的风格，然后就会对代码进行格式化。
|
1 2 3 4 |
$ astyle test.cpp --style=linux Formatted /data/code/c/0-test/test.cpp $ ls test.cpp test.cpp.orig # 生成一个.orig 作为源代码备份 |
常见的 style 选项有：ansi kr linux gnu java 等，更多可以查看官方文档 Brace Style Options 。
如需指定输入输出可通过设置--stdin 和--stdout 选项：
|
1 |
$ astyle --stdin=test.cpp --stdout=linux.cpp --style=linux |
2.2 生成各种风格样例
准备一个源文件 test.cpp，内容如下：
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 |
#include<iostream> using namespace std; void f(int i) { if (i == 1) { cout << "helloworld" << endl; } else { cout << "HELLOWORLD" << endl; } } int main() { cout << "HelloWorld" << endl; return 0; } |
编写一个 shell 脚本分别输出不同格式：
|
1 2 3 4 5 6 7 8 |
$ #! /bin/bash sts=("bsd" "allman" "ansi" "kr" "linux" "gnu" "java") for i in ${sts[@]} do astyle --stdin=test.cpp --stdout=$i.cpp --style=$i done |
运行脚本将会生成不同格式的代码文件：
|
1 2 3 4 5 6 7 8 9 10 11 12 13 |
$ ls -al total 44 drwxrwxr-x 2 ma ma 4096 May 4 17:20 . drwxrwxr-x 9 ma ma 4096 May 4 17:20 .. -rw-rw-r-- 1 ma ma 248 May 4 17:20 allman.cpp -rw-rw-r-- 1 ma ma 248 May 4 17:20 ansi.cpp -rw-rw-r-- 1 ma ma 248 May 4 17:20 bsd.cpp -rw-rw-r-- 1 ma ma 272 May 4 17:20 gnu.cpp -rw-rw-r-- 1 ma ma 236 May 4 17:20 java.cpp -rw-rw-r-- 1 ma ma 236 May 4 17:20 kr.cpp -rw-rw-r-- 1 ma ma 236 May 4 17:20 linux.cpp -rwxrwxr-x 1 ma ma 152 May 4 17:19 run.sh -rw-rw-r-- 1 ma ma 236 May 4 17:13 test.cpp |
三、不同风格的特点
3.1 linux 风格
特点：函数的括号上下对齐，条件控制的括号没有对齐。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 |
#include<iostream> using namespace std; void f(int i) { if (i == 1) { cout << "helloworld" << endl; } else { cout << "HELLOWORLD" << endl; } } int main() { cout << "HelloWorld" << endl; return 0; } |
3.2 ansi 风格
特点：所有的括号都一一对齐。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 |
#include<iostream> using namespace std; void f(int i) { if (i == 1) { cout << "helloworld" << endl; } else { cout << "HELLOWORLD" << endl; } } int main() { cout << "HelloWorld" << endl; return 0; } |
3.3 gnu 风格
特点：括号一一对齐，条件控制语句的括号会增加一个缩进。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 |
void f(int i) { if (i == 1) { cout << "helloworld" << endl; } else { cout << "HELLOWORLD" << endl; } } int main() { cout << "HelloWorld" << endl; return 0; } |
3.4 bsd 风格
特点：括号一一对齐。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 |
#include<iostream> using namespace std; void f(int i) { if (i == 1) { cout << "helloworld" << endl; } else { cout << "HELLOWORLD" << endl; } } int main() { cout << "HelloWorld" << endl; return 0; } |
3.5 java 风格
特点：所有的括号都没有对齐，直接写在同一行的最后。
|
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 |
#include using namespace std; void f(int i) { if (i == 1) { cout << "helloworld" << endl; } else { cout << "HELLOWORLD" << endl; } } int main() { cout << "HelloWorld" << endl; return 0; } |
评论