From 64fd8e34cf31c96f9fa4d12169df80e60f9c7cb2 Mon Sep 17 00:00:00 2001 From: Yuyang Yu Date: Tue, 12 May 2020 17:38:35 +0800 Subject: [PATCH] Update README.md MIME-Version: 1.0 Content-Type: text/plain; charset=UTF-8 Content-Transfer-Encoding: 8bit 更新gitbook说明 --- p3c-gitbook/README.md | 6 +++++- 1 file changed, 5 insertions(+), 1 deletion(-) diff --git a/p3c-gitbook/README.md b/p3c-gitbook/README.md index 86e55f3..7eedbe3 100644 --- a/p3c-gitbook/README.md +++ b/p3c-gitbook/README.md @@ -2,4 +2,8 @@     《阿里巴巴Java开发手册》是阿里巴巴集团技术团队的集体智慧结晶和经验总结，经历了多次大规模一线实战的检验及不断的完善，系统化地整理成册，回馈给广大开发者。现代软件行业的高速发展对开发者的综合素质要求越来越高，因为不仅是编程知识点，其它维度的知识点也会影响到软件的最终交付质量。比如：数据库的表结构和索引设计缺陷可能带来软件上的架构缺陷或性能风险；工程结构混乱导致后续维护艰难；没有鉴权的漏洞代码易被黑客攻击等等。所以本手册以Java开发者为中心视角，划分为编程规约、异常日志、单元测试、安全规约、工程结构、MySQL数据库六个维度，再根据内容特征，细分成若干二级子目录。根据约束力强弱及故障敏感性，规约依次分为强制、推荐、参考三大类。对于规约条目的延伸信息中，“说明”对内容做了适当扩展和解释；“正例”提倡什么样的编码和实现方式；“反例”说明需要提防的雷区，以及真实的错误案例。
    本手册的愿景是码出高效，码出质量。现代软件架构都需要协同开发完成，高效协作即降低协同成本，提升沟通效率，所谓无规矩不成方圆，无规范不能协作。众所周知，制订交通法规表面上是要限制行车权，实际上是保障公众的人身安全。试想如果没有限速，没有红绿灯，谁还敢上路行驶。对软件来说，适当的规范和标准绝不是消灭代码内容的创造性、优雅性，而是限制过度个性化，以一种普遍认可的统一方式一起做事，提升协作效率。代码的字里行间流淌的是软件生命中的血液，质量的提升是尽可能少踩坑，杜绝踩重复的坑，切实提升质量意识。 -
    考虑到可以零距离地与众多开发同学进行互动，决定未来在线维护《手册》内容，此1.3.1的PDF版本，是对外释放的最终纪念版，铭记发布第一版以来的358天旅程；我们已经在杭州云栖大会上进行了阿里巴巴Java开发规约插件[点此下载](https://github.com/alibaba/p3c)，阿里云效（一站式企业协同研发云）也集成了代码规约扫描引擎。最后，《码出高效——阿里巴巴Java开发手册详解》即将出版，敬请关注。 \ No newline at end of file +
    考虑到可以零距离地与众多开发同学进行互动，决定未来在线维护《手册》内容，此1.3.1的PDF版本，是对外释放的最终纪念版，铭记发布第一版以来的358天旅程；我们已经在杭州云栖大会上进行了阿里巴巴Java开发规约插件[点此下载](https://github.com/alibaba/p3c)，阿里云效（一站式企业协同研发云）也集成了代码规约扫描引擎。最后，《码出高效——阿里巴巴Java开发手册详解》即将出版，敬请关注。 + + + +> 当前gitbook已经和最新版规约内容不一致，请参考最新版规约。 -- GitLab