# Qtc_AStyle

**Repository Path**: zigbeeroom/qtc_astyle

## Basic Information

- **Project Name**: Qtc_AStyle
- **Description**: 这是一个使用Artistic Style 2.04静态库的Qt Creator的插件，实现在Qt Creator IDE下快速对源代码文件的代码格式进行美化的功能
- **Primary Language**: C++
- **License**: LGPL-2.1
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 6
- **Created**: 2022-05-28
- **Last Updated**: 2022-05-28

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

简介
========
Qtc_AStyle是一个Qt Creator IDE的插件，使用了Artistic Style V2.04的静态库，IDE加载这个插件后，在选项中可以很直观地定义自己的代码风格，然后一键对整个项目所有的源文件进行代码格式美化。

使用说明
========
下载
--------
下载bin\4.15.0目录下的AStyle4.dll文件，这是一个已经编译好的插件动态库文件，适用于官网下载的Qt Creator （windows）4.15.0及其以后的版本程序，将AStyle4.dll文件复制到 C:\Qt\Tools\QtCreator\lib\qtcreator\plugins 目录下，重新启动Qt Creator，即会自动加载该插件，在QtCreator菜单"Help"-"About Plugins..."中能够看到该插件
![](http://git.oschina.net/zhouliqiu/qtc_astyle/raw/master/screenshot/about.png)

选项
--------
在QtCreator菜单"Tools"-"Options..."中可以看到该插件的设置项，默认配置参考华为代码规范设置。
![](http://git.oschina.net/zhouliqiu/qtc_astyle/raw/master/screenshot/option.png)
移动鼠标到每个选项上，弹出的Tooltip可以看到每个选项的具体含义。
![](http://git.oschina.net/zhouliqiu/qtc_astyle/raw/master/screenshot/detail.png)

使用
--------
### 格式化当前文件
打开一个源文件，使用快捷键"Alt+F8"，或者选择菜单"Tools"-"代码格式化"-"格式化当前文件"
### 格式化当前项目
选择菜单"Tools"-"代码格式化"-"格式化当前项目"，弹出格式化当前项目对话框，从下拉框中选择项目，勾选需要格式化的文件，点击“格式化”，注意：格式化当前项目时，请保存所有当前打开的文档，否则会丢失任何未保存的修改。
![](http://git.oschina.net/zhouliqiu/qtc_astyle/raw/master/screenshot/project.png)

自行编译
========

QtCreator插件的编译需要使用QtCreator的源代码和编译输出库，所以要先得到一个QtCreator 源码目录和一个编译输出目录
由于QtCreator代码里枚举变量经常改变,代码只对应当前QtCreator的最新版本

* 在http://download.qt-project.org/ 下载一个最新版本的QtCreator源代码

* 解压缩到一个目录中，比如D:\qt-creator-src-4.15.0

* 新建一个目录D:\qt-creator-build-4.15.0

* 运行QtCreator程序打开D:\qt-creator-src-4.15.0\QtCreator.pro

* 选择一个Qt版本的构建配置，Qt版本和编译器的选择很重要，插件的qt库版本和编译器版本必须要跟qtcreator.exe 一致才能被正确加载。

  比如现在官方网站下载的QtCreator安装程序都是使用Qt5.15.2+Vs2019（64位）编译出来的，那么编译插件时的构建配置也必须是Qt5.15.2+Vs2019（64位）。

* 使用Shadow build，目录选择到D:\qt-creator-build-4.15.0

* 选择release编译，开始编译，大概需要30分钟。

* 运行QtCreator程序打开qtc_astyle.pro文件，选择跟编译QtCreator同版本的构建配置

* 打开astyle.pro文件，找到第49行，把QtCREATOR_SOURCES=改成你的QtCreator源码目录 第54行，把IDE_BUILD_TREE=改成QtCreator的编译输出目录

* 选择release编译，开始编译，编译完成后，自动在QtCreator的编译输出目录里的lib/qtcreator/plugins/下生成动态库文件。