编程技巧

C/C++ 代码风格美化

良好的代码风格十分必要 —— 佚名

这里的方法只针对 C/C++ 代码。至于MATLAB,由于这货自带编辑器(editor)与集成开发环境(IDE), 可以参考官网“提高代码可读性(Improve Code Readability)”。

注:原文是英文版的,想看中文版的需要登录。

我们用到的是大名鼎鼎的 LLVM —— 的一个子工具 —— clang-format.

安装

Ubuntu 或者类 Debian 系统:

$ sudo apt install clang-format

CentOS 或者类 RHEL 系统:

# yum install clang

Windows 需要访问 LLVM 官网下载 Windows 安装包(Windows installer)。

注:bicmr 集群主节点已安装 clang-format;任何未授权的权限提升(使用sudo)均被视为危险行为!

使用方法

执行 clang-format -version 检查安装是否成功:成功则出现版本号;否则请参考上节。

clang-format 使用方法为

clang-format [-参数] <输入文件>

参数说明:

	-style=LLVM|Google|Chromium|Mozilla|Webkit
		设定风格;目前只支持这5种风格;默认是LLVM风格

	-i
		文件替换;如果指定了这个参数则直接替换源文件,否则将美化过的代码打印到标准输出

其中带方括号的是可选参数,尖括号的是必须参数(Linux命令手册中也是类似的)。

笔者认为这些不同的风格都大同小异,如果没有硬性规定选自己喜欢的就好。 由于历史原因笔者最喜欢Webkit风格,即“大括号换行”、“缩进4空格”, 所以美化位于 ~/Download 目录下的 helloWorld.c 就需要执行

clang-format -style=Webkit -i ~/Download/helloWorld.c

更多资料请参考“官方文档(Clang 4.0 documentation)”.