From aa74d606fd6ed0e0f020ca6ee00bad3e3dffe8f2 Mon Sep 17 00:00:00 2001 From: James Poulakos Date: Tue, 31 Oct 2017 05:50:35 -0500 Subject: [PATCH 1/2] docs: grammar updates --- README.md | 6 +++--- 1 file changed, 3 insertions(+), 3 deletions(-) diff --git a/README.md b/README.md index 4f0166c33..f2d49d64a 100644 --- a/README.md +++ b/README.md @@ -7,7 +7,7 @@ [![License](https://img.shields.io/badge/license-Apache%202-4EB1BA.svg)](https://www.apache.org/licenses/LICENSE-2.0.html) ## Preface -> We are pleased to present Alibaba Java Coding Guidelines, which consolidates the best programming practices over the years from Alibaba Group's technical teams. A vast number of Java programming teams impose demanding requirements on code quality across projects as we encourage reuse and better understanding of each other's programs. We have seen many programming problems in the past. For example, defective database table structures and index designs may cause software architecture flaws and performance risks. Yet as another example, confusing code structures make it difficult to maintain. Furthermore, vulnerable code without authentication is prone to hackers’ attacks. To address those kinds of problems, we developed this document for Java developers in Alibaba. +> We are pleased to present Alibaba Java Coding Guidelines which consolidates the best programming practices over the years from Alibaba Group's technical teams. A vast number of Java programming teams impose demanding requirements on code quality across projects as we encourage reuse and better understanding of each other's programs. We have seen many programming problems in the past. For example, defective database table structures and index designs may cause software architecture flaws and performance risks. Another example is confusing code structures being difficult to maintain. Furthermore, vulnerable code without authentication is prone to hackers’ attacks. To address these kinds of problems, we developed this document for Java developers at Alibaba. For more information please refer the *Alibaba Java Coding Guidelines*: - 中文版: *[阿里巴巴Java开发手册](https://github.com/alibaba/p3c/blob/master/%E9%98%BF%E9%87%8C%E5%B7%B4%E5%B7%B4Java%E5%BC%80%E5%8F%91%E6%89%8B%E5%86%8C%EF%BC%88%E7%BB%88%E6%9E%81%E7%89%88%EF%BC%89.pdf)* @@ -20,7 +20,7 @@ The project consists of 3 parts: - [Eclipse plugin](eclipse-plugin) ## Rules -49 rules are realized based on PMD, please refer the P3C-PMD documentation for more detailed information. 4 rules implemented within IDE plugins (IDEA and Eclipse) as following: +Forty-nine rules are realized based on PMD, please refer the P3C-PMD documentation for more detailed information. Four rules are implemented within IDE plugins (IDEA and Eclipse) as follows: - ``[Mandatory]`` Using a deprecated class or method is prohibited. Note: For example, decode(String source, String encode) should be used instead of the deprecated method decode(String encodeStr). Once an interface has been deprecated, the interface provider has the obligation to provide a new one. At the same time, client programmers have the obligation to check out what its new implementation is. @@ -37,7 +37,7 @@ The project consists of 3 parts: Note: String can be used as the key of Map since these two methods have been rewritten. ## Join us -If you have any questions or some advices, please contact with junlie whose email is caikang.ck@alibaba-inc.com, and welcome to join us to make project P3C perfect to serve more programmers. +If you have any questions or some advice, please contact with junlie whose email is caikang.ck@alibaba-inc.com, and please join us to make project P3C perfect for more programmers. Please follow our weChat official account as ali_yunxiao blow: From 71bdcdefbd58e19d375aecf2da76ec79e0223d2d Mon Sep 17 00:00:00 2001 From: SeanCai Date: Thu, 16 Nov 2017 01:12:50 -0600 Subject: [PATCH 2/2] =?UTF-8?q?=E4=B8=AD=E6=96=87=E4=B9=B1=E7=A0=81?= =?UTF-8?q?=E5=AD=97=E4=BD=93=E6=8F=8F=E8=BF=B0?= MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit --- idea-plugin/README_cn.md | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/idea-plugin/README_cn.md b/idea-plugin/README_cn.md index 8446c23ab..90ab1feb9 100644 --- a/idea-plugin/README_cn.md +++ b/idea-plugin/README_cn.md @@ -28,7 +28,7 @@ ### [中文乱码解决方法](https://github.com/alibaba/p3c/issues/32#issuecomment-336762512) -1. 修改字体——Appearance&Behavior -> Appearance -> UI Options -> Name 里面设置成微软雅黑（microsoft yahei light） +1. 修改字体——Appearance&Behavior -> Appearance -> UI Options -> Name 里面设置成中文字体——如微软雅黑（microsoft yahei light）、文泉驿(linux) ![](https://gw.alicdn.com/tfscom/TB14wTmm3oQMeJjy0FoXXcShVXa.png)