Merge pull request alibaba#79 from SeanCai/master

中文手册

eclipse-plugin/README.md

@@ -9,7 +9,7 @@
 ```
 mvn -U clean install
 ```
-
+## [中文使用手册](README_cn.md)
 ## <font color="green">Install</font>
 1. <font color="blue">Help >> Install New Software
 then enter this update site URL [https://p3c.alibaba.com/plugin/eclipse/update](https://p3c.alibaba.com/plugin/eclipse/update)</font>
@@ -28,4 +28,4 @@ then enter this update site URL [https://p3c.alibaba.com/plugin/eclipse/update](
   ![Analyze](doc/images/eclipse_analyze.png) 
 
   ![Analyze](doc/images/analyze_result.png) 
-
+

eclipse-plugin/README_cn.md

@@ -0,0 +1,63 @@
+> 首先非常感谢大家对插件的支持与意见，Eclipse的功能相对来说比较简单，希望有更多的同学加入进来一起完善。
+
+## 插件安装
+环境：JDK1.8，Eclipse4+。有同学遇到过这样的情况，安装插件重启后，发现没有对应的菜单项，从日志上也看不到相关的异常信息，最后把JDK从1.6升级到1.8解决问题。
+
+Help -> Install New Software...
+
+![](https://gw.alicdn.com/tfscom/TB1LOyPifJNTKJjSspoXXc6mpXa.png)
+
+输入Update Site地址：https://p3c.alibaba.com/plugin/eclipse/update 回车，然后勾选Ali-CodeAnalysis，再一直点Next Next...按提示走下去就好。 然后就是提示重启了，安装完毕。
+
+![](https://gw.alicdn.com/tfscom/TB1Ud5kifBNTKJjSszcXXbO2VXa.png)
+
+`注意：有同学反映插件扫描会触发JPA插件启动后台线程执行不明任务，如果不需要的话卸载掉JPA插件即可，目前尚未发现原因`
+
+
+## 插件使用
+
+目前插件实现了开发手册中的53条规则，大部分基于PMD实现，其中有4条规则基于Eclipse实现，支持4条规则的QuickFix功能。
+
+	* 所有的覆写方法，必须加@Override注解， 
+ 	* if/for/while/switch/do等保留字与左右括号之间都必须加空格,
+ 	* long或者Long初始赋值时，必须使用大写的L，不能是小写的l）
+ 	* Object的equals方法容易抛空指针异常，应使用常量或确定有值的对象来调用equals。
+
+目前不支持代码实时检测，需要手动触发，希望更多的人加入进来一起把咱们的插件做得越来越来，尽量提升研发的使用体验。
+
+
+### 代码扫描
+可以通过右键菜单、Toolbar按钮两种方式手动触发代码检测。同时结果面板中可以对部分实现了QuickFix功能的规则进行快速修复。
+
+#### 触发扫描
+在当前编辑的文件中点击右键，可以在弹出的菜单中触发对该文件的检测。
+
+![](https://gw.alicdn.com/tfscom/TB1XGo8iPihSKJjy0FeXXbJtpXa.png)
+
+
+在左侧的Project目录树种点击右键，可以触发对整个工程或者选择的某个目录、文件进行检测。 
+
+![](https://gw.alicdn.com/tfscom/TB18UsJi2NZWeJjSZFpXXXjBFXa.png)
+
+
+也可以通过Toolbar中的按钮来触发检测，目前Toolbar的按钮触发的检测范围与您IDE当时的焦点有关，如当前编辑的文件或者是Project目录树选中的项，是不是感觉与右键菜单的检测范围类似呢。 
+
+  ![](https://gw.alicdn.com/tfscom/TB1vt1oifBNTKJjSszcXXbO2VXa.png)
+
+
+#### 扫描结果  
+简洁的结果面板，按规则等级分类，等级->规则->文件->违规项。同时还提供一个查看规则详情的界面。
+
+清除结果标记更方便，支持上面提到的4条规则QuickFix。
+
+![](https://gw.alicdn.com/tfscom/TB1_uFJi6ihSKJjy0FlXXadEXXa.png)
+
+#### 查看所有规则
+![](https://gw.alicdn.com/tfscom/TB1UNTnmYsTMeJjSszhXXcGCFXa.png)
+![](https://gw.alicdn.com/tfscom/TB1_rf7sOAKL1JjSZFoXXagCFXa.png)
+
+#### 国际化
+
+![](https://gw.alicdn.com/tfscom/TB1KsyYsiFTMKJjSZFAXXckJpXa.png) 
+
+![](https://gw.alicdn.com/tfscom/TB19bzdm3oQMeJjy1XaXXcSsFXa.png)

idea-plugin/README.md

@@ -1,4 +1,4 @@
-# Idea Plugin
+# Idea Plugin 
 ---
 ## <font color="green">Prepare</font>
 - Project JDK: 1.7+
@@ -23,7 +23,7 @@ gradle runIde -Pidea_version=14.1.7
 ``` groovy
 compile 'com.alibaba.p3c.idea:p3c-common:1.0.0'
 ```
-
+## [中文使用手册](README_cn.md)
 ## <font color="green">Install</font>
 ### Install from repositories
 1. <font color="blue">Settings >> Plugins >> Browse repositories... </font>
@@ -72,7 +72,7 @@ compile 'com.alibaba.p3c.idea:p3c-common:1.0.0'
 
 	   ![Font](doc/images/change_name.png) 
 
-	* <font color="blue">Switch Language to English and restrt.</font>
+	* <font color="blue">Switch Language to English and restart.</font>
 
 	   ![Switch language](doc/images/normal_view.png) 
 

idea-plugin/README_cn.md

@@ -0,0 +1,113 @@
+> 首先非常感谢大家对插件的支持与意见，英文版的文档还是略为简单，这里详细介绍一下插件的安装使用。
+
+## 插件安装
+### 通过Jetbrains官方仓库安装
+1. 打开 Settings >> Plugins >> Browse repositories...
+
+ ![](https://gw.alicdn.com/tfscom/TB1Qn83ifBNTKJjy1zdXXaScpXa.png)
+
+2. 在搜索框输入alibaba即可看到Alibaba Java Code Guidelines插件，点击Install进行安装，然后重启IDE生效 `注意：因为插件zip包托管在Jetbrains官方CDN上，所以是从国外的服务器进行下载，可能会出现超时的情况`
+
+   ![](https://gw.alicdn.com/tfscom/TB1vcGbmYsTMeJjy1zcXXXAgXXa.png)
+
+### 通过下载安装包进行安装
+1. 打开[插件](https://plugins.jetbrains.com/plugin/10046-alibaba-java-coding-guidelines)页面
+
+![download](https://gw.alicdn.com/tfscom/TB1WcF3hzlxYKJjSZFuXXaYlVXa.png)
+
+2. Settings >> Plugins >> Install plugin from disk...，选择刚刚下载的zip包安装，然后重启IDE
+
+ ![](https://gw.alicdn.com/tfscom/TB1WFsKiqigSKJjSsppXXabnpXa.png)
+
+
+### 注意
+
+最低支持IDEA版本为14.1（buildNumber 141.0，可以在About Intellij IDEA中查看版本信息），使用IDEA14的同学最好升级到14.1.7(<a href="https://www.jetbrains.com/idea/download/previous.html" target="_blank">历史版本传送门</a>)
+
+插件基于JDK1.7打包，所以IDEA启动时使用的JDK版本如果是1.6的话就会报Unsupported major.minor version 51.0异常，建议大家都升级一下。
+
+### [中文乱码解决方法](https://github.com/alibaba/p3c/issues/32#issuecomment-336762512)
+
+1. 修改字体——Appearance&Behavior -> Appearance -> UI Options -> Name 里面设置成微软雅黑（microsoft yahei light）
+
+	![](https://gw.alicdn.com/tfscom/TB14wTmm3oQMeJjy0FoXXcShVXa.png) 
+
+2. Switch Language to English and restart.
+
+	![](https://gw.alicdn.com/tfscom/TB1Z6u1mYsTMeJjSszhXXcGCFXa.png) 
+	   
+
+## 插件使用
+
+目前插件实现了开发手册中的的53条规则，大部分基于PMD实现，其中有4条规则基于IDEA实现，并且基于IDEA <a href="https://www.jetbrains.com/help/idea/code-inspection.html" target="_blank">Inspection</a>实现了实时检测功能。部分规则实现了Quick Fix功能，对于可以提供Quick Fix但没有提供的，我们会尽快实现，也欢迎有兴趣的同学加入进来一起努力。
+目前插件检测有两种模式：实时检测、手动触发。
+
+### 实时检测
+实时检测功能会在开发过程中对当前文件进行检测，并以高亮的形式提示出来，同时也可以支持Quick Fix，该功能默认开启，可以通过配置关闭。 
+
+#### 结果高亮提示
+
+<p style="text-indent:2em">检测结果高亮提示，并且鼠标放上去会弹出提示信息。</p>
+
+  ![](https://gw.alicdn.com/tfscom/TB17wt3mYsTMeJjSszdXXcEupXa.png)
+
+  ![](https://gw.alicdn.com/tfscom/TB1Rq85ifNNTKJjSspkXXaeWFXa.png)
+
+#### <a href="https://www.jetbrains.com/help/idea/intention-actions.html" target="_blank">Intention</a> QuickFix功能
+
+Alt+Enter键可呼出Intention菜单，不同的规则会提示不同信息的Quick Fix按钮
+
+  ![](https://gw.alicdn.com/tfscom/TB1twLMsOAKL1JjSZFoXXagCFXa.png)
+
+#### 关闭实时检测  
+在某些情况下，我们不希望对代码提示违规信息，比如我们在阅读Github开源项目代码的时候，如果界面出现一堆红色、黄色的提示，此时心里肯定是飘过一万只草泥马。这个时候我们可以通过Inspection的设置关闭实时检测功能。
+1. 通过右键快速关闭（打开）所有规则的实时检测功能
+
+  ![](https://gw.alicdn.com/tfscom/TB1dBbDe_1z01JjSZFCXXXY.XXa.png)
+2. 通过Settings >> Editor >> Inspections 进行手动设置  
+
+ ![](https://gw.alicdn.com/tfscom/TB1zhCBsiFTMKJjSZFAXXckJpXa.png)
+
+也可以关闭某条规则的实时检测功能或者修改提示级别。
+
+### 代码扫描
+
+可以通过右键菜单、Toolbar按钮、快捷键三种方式手动触发代码检测。同时结果面板中可以对部分实现了QuickFix功能的规则进行快速修复。 
+
+#### 触发扫描
+在当前编辑的文件中点击右键，可以在弹出的菜单中触发对该文件的检测。
+
+   ![](https://gw.alicdn.com/tfscom/TB1Wj49mYsTMeJjSszdXXcEupXa.png)
+
+在左侧的Project目录树种点击右键，可以触发对整个工程或者选择的某个目录、文件进行检测。
+
+   ![](https://gw.alicdn.com/tfscom/TB1h_XciWmgSKJjSspiXXXyJFXa.png)
+
+   如果您打开了IDE的Toolbar，也可以通过Toolbar中的按钮来触发检测，目前Toolbar的按钮触发的检测范围与您IDE当时的焦点有关，如当前编辑的文件或者是Project目录树选中的项，是不是感觉与右键菜单的检测范围类似呢。
+
+   ![](https://gw.alicdn.com/tfscom/TB1q3Nfi6uhSKJjSspmXXcQDpXa.png)
+   使用快捷键（Ctrl+Shift+Alt+J）触发弹出窗口，选择检测范围；您也可自定义快捷键。
+
+   ![](https://gw.alicdn.com/tfscom/TB1k4uXmYwTMeJjSszfXXXbtFXa.png) 
+
+   ![](https://gw.alicdn.com/tfscom/TB1ObqXifxNTKJjy0FjXXX6yVXa.png)
+
+#### 扫描结果  
+检测结果直接使用IDEA Run Inspection By Name功能的结果界面，插件的检测结果分级为Blocker、Critical、Major。默认按等级分组，方便统计每个级别错误的数量。
+
+![](https://gw.alicdn.com/tfscom/TB1aC1yifJNTKJjSspoXXc6mpXa.png)
+
+
+默认情况我们在结果面板需要双击具体违规项才能打开对应的源文件，开启Autoscroll To Source选项，单击面板中的文件名、或者是具体的违规项的时候IDEA会自动打开对应的源文件。
+
+   ![](https://gw.alicdn.com/tfscom/TB1aIixmYsTMeJjy1zcXXXAgXXa.png)
+
+#### QuickFix
+对于实现Quick Fix的规则，在结果面板中可以直接一键修复 `注意：IDEA14、15可以通过左下角的灯泡进行一键修复操作。`
+
+   ![](https://gw.alicdn.com/tfscom/TB1Kw5Vm3oQMeJjy0FpXXcTxpXa.png)
+
+   ![](https://gw.alicdn.com/tfscom/TB1lHZZiGagSKJjy0FbXXa.mVXa.png)
+
+#### 其他
+面板中其他按钮的功能大家自行探索吧，就不一一赘述了