astyle代码格式化..doc

Artistic Style 1.24 A Free, Fast and Small Automatic Formatterfor C, C++, C#, and Java Source Code 项目网址：/astyle.html Astyle可以从命令行运行，由于它用C++编写，也可以作为C++类用在C++程序中。 概述 行尾结束符 格式化后的行尾结束符和格式化之前的是一样的，如果原文件中有多种行尾结束符，则采用最常用的那种。Astyle可以对此进行设置。 文件类型 Java .java C# .cs 其他的作为C或者C++处理 可以通过 –mode= 来进行设置 通配符和递归处理 Astyle可以递归地处理目录，以及类似于*.cpp,*.c??的文件，对于linux要用引号包含含有通配符的文件，对windows如果文件或路径中有空格，也要用引号包含起来 文件名 处理source.cpp后，生成了格式化后的文件source.cpp和保存的格式化之前的文件source.cpp.orig。这个orig的后缀可以通过 –suffix=进行设置，或者用 –n 或者 –suffix=none 来表示不保存格式化之前的文件 其他注意事项 Astyle可以格式化标准的类库描述，例如Open GL,wxWidgets,QT,MFC等 可以格式化嵌入式SQL语句 不能格式化UTF16或者UTF32编码的文件 那些多行的，而且像Python那样不是类似于C语言格式的嵌入式语句往往会被格式化地不怎么样，定义函数的宏定义也会使得下面的代码格式不好，如果有这样的情况，可以用 –exclude=选项 使用方法 Astyle是一个命令行工具，使用方法 astyle [options] SourceFile1 SourceFile2 SourceFile3 […] example: 格式一个文件 astyle --style=allman /home/user/project/foo.cpp 递归地格式cpp和h文件 astyle --style=allman --recursive /home/user/project/*.cpp /home/user/project/*.h 或者将原文件格式化后起一个不同的名字 astyle [options] OriginalSourceFile BeautifiedSourceFile 和 是重定向符号，这种方法一次只能处理一个文件，不支持通配符，也不生成备份文件 命令行选项 如果不指定任何选项，则只产生4个空格的缩进 选项有两种书写方式： 长形式： 以 -- 注意是两个 – 开头，一次写一个 Example: --brackets=attach --indent=spaces=4 短形式 以一个 – 开头，能头将好几个选项合在一起写 -b -p -s4，可以简写为 –bps4 选项文件 一个可选的默认的选项文件能够补充或者替代命令行选项，需注意以下几点： 命令行选项优先，级别高，发生冲突优先用命令行选项 Astyle通过以下方式找选项文件 命令行选项 –options= 环境变量ARTISTIC_STYLE_OPTIONS指定的文件和目录 环境变量HOME指向的目录下名为 .astylerc(注意前面有个点)的文件，例如Linux下$HOME/.astylerc 环境变量USERPROFILE指向的目录下名为astylerc的文件，例如windows下%USERPROFILE%\astylerc 命令行用 –options=none 来关闭寻找选项文件的功能 选项文件中的选项可以用新行 ， tab键，逗号，空格等区分 在选项文件中，很长的选项可以不用写前面的 –符号 以#开头的行做注释 示例： # this line is a comment --brackets=attach # this is a line-end comment # long options can be written without the preceding -- indent-switches # cannot do this on the command line # short options must have the preceding - -t -p # short options can be concatenated together -M65Ucv 预定义的格式化选项 预定义的类型通过定义其它的选项来定义!预定义的类型优先级要比其它单独的选项定义要高。每