公司培训lesson 1-代码质量

课堂讲义

1. 代码质量五大原则
   1. 编码规范
      1. 命名规范。学会合理科学的命名类名、方法名、变量名。命名宗旨：简洁明了，见名只意；了解常用单词缩写
      2. 注释。是否写根据所处工作环境的需要而决定。将以源代码写成以“注释”的说明类文档为目标
      3. 缩进。团队应该统一缩进格式。注意Windows平台与Linux平台的编码差异，最好以空格来代替Tab
      4. 页宽。代码最好的呈现方式是以“块”状呈现。编码规范里往往会要求设置IDE页宽，一行内的代码量不要超过所设置的页宽，超出部分换行切向右对齐
      5. 不同修饰符，常、静态变量，普通变量的排序方式
   2. 代码重复
      1. 实际开发中应避免为了图方便，简单而对某些代码进行粗暴的CTRL C + CTRL V
      2. 当项目庞大时如何避免对重复代码遗漏，可借助IDE所提供的一些自动检查来规避
      3. 当出现重复代码时，多想想面向对象原则（抽象，封装，多态）的特性，通过 这些特性去修改重复代码
      4. 做好团队沟通，避免个团队成员重复的“造轮子”
   3. 测试代码覆盖率
      1. 测试代码覆盖率的作用往往是生成某种形式上的报告类文件提供给某种特定人员的产物
      2. 在项目进度紧张的情况下，快速有效的对有"隐患"代码进行检查，活用main方法做到增量开发
      3. 后期需对测试报告类进行补全验证
      4. 了解TDD测试驱动开发
   4. 依赖项分析
   5. 代码复杂度
      1. 不管多复杂的业务，多复杂的算法都应尽最大努力使他们简洁化
      2. 逻辑逆推，减少逻辑判断嵌套
      3. 复杂的逻辑条件主动抽象
      4. 掌握switch与if else的差异化
      5. 减少循环嵌套，主动将嵌套循环抽象
      6. 掌握各种循环while，while do ， do while ，for ， for each，stream等的差异化
      7. 避免出现大量无营养含量代码，如各种get/set，通过设计模式，反射等手段来解决此类问题
2. 如何提高代码质量
   1. 结对编程
      1. 如何有效的结对编程
      2. 在项目组中尝试与另一团队成员开展结对编程的工作方式
   2. coding review
      1. 能够做到代码在“脱手（如提交至版本库）”之前进行自我的codeing review
      2. 如何有效的在团队中进行coding review
      3. 在项目组中尝试对每日的有效代码进行coding review
   3. 开源代码
      1. 代码质量最好的学习途径，如jdk，spring源代码
      2. 临摹，模拟源代码的编写方式
      3. 不断审视，解读这类源代码的编写思维
   4. 工具运用
      1. 了解代码检查工具类，如findbug，QAplug，PMD等
      2. 定期通过这类辅助工具对代码进行检查
      3. 最大程度的独立解决辅助工具标记出的问题源
   5. 责任
      1. 代码质量从侧面意义反应出该开发人员是否对公司，同事，自己称职、负责
      2. 以上均为方法论，而最根本的核心在于开发人员的工作态度，工作责任心
      3. 培养自己的工作责任心，势必会在代码质量这块进步

我的笔记：

代码质量影响因素

1. 编码规范

命名、注释（代码就是最好的注释，注意命名和复杂度）、缩进（统一Tab或四个空格）、页宽（成块的整洁的代码）。

2. 代码重复

3. 测试

测试覆盖率、增量开发（在main方法中测试不确定的代码）、TDD（优：bug少，缺：时间消耗多）。

4. 代码依赖项
5. 代码复杂度

面向过程 -> 抽象重构、if/for不能嵌套超过两层、逻辑太多的地方抽象成方法、减少方法参数、逆推（比如先写false部分）、封装不变，抽象变量。

6. 效率

先功能后重构、结合业务场景考虑效率。不要怕暴露问题（结对编程）、项目进度（十分钟以上求助他人）。

如何提高代码质量

• 结对编程
• 代码review
• 开源代码（JDK、Spring）
• 工具运用（findBug等）
• 责任心（你写的代码是给别人看的）

课后作业

  需求：某公司人力资源部需对已有薪资体系进行改造。现急需一份员工薪资计算程序导入“员工出勤报表”后生成“员工薪资报表”，具体已知项如下：

1. 某公司工种分为干部员工，基层员工两种；
2. 干部员工薪资基数为1.68 , 基层员工薪资基数为1.1;
3. 薪资计算公式：基本工资/22 × 实际到岗工作日 × 薪资基数 - 社保金额；（忽略个人所得税）
4. 社保金额计算公式 ：基本工资 × 8% 　＋　基本工资×１％　＋　基本工资×2%
5. 员工签约薪资表

工号	员工姓名	基本薪资	工种
１	马云	8888	干部
2	马化腾	8888	干部
3	任正非	8600	干部
4	刘亦菲	3500	基层
5	沈腾	5800	基层
6	刘谋	6000	基层
7	陈意涵	4000	基层
8	林志玲	7000	干部
9	孙红雷	7500	基层

1. 员工１月出勤报表

工号	出勤天数
１	10.5
2	12
3	20
4	22
5	21
6	18
7	22
8	20
9	21.5

1. 员工薪资报表格式

工号

姓名

实际出勤天数

当月薪资

社保扣款

其他扣款

实际薪资

 附上作业代码，欢迎指正：

github链接