31 | 理论五：让你最快速地改善代码质量的20条编程规范（上）

什么时候开始 进入正题呀，前奏太长了

在 User 类这样一个上下文中，我们没有在成员变量的命名中重复添加“user”这样一个前缀单词，而是直接命名为 name、password、avatarUrl。 但示例代码好像都带了 user 前缀？

检验字符是否0-9，a-z那行代码可读性不高，可以抽成一个方法，通过注释理解具体含义

1 缺类注释 2 看团队英文水平

我不明白为什么会问注释用英文 或者中文来写 这种问题。又不是国际化项目为什么用英文，就算国际化项目，中国公司做的为什么不能用中文？

有没有相关的资料，能把开发中常用的缩写罗列出来？因为很多人都是乱用缩写，，，

我是用jdk1.8,commons-lang3-3.6测试的，比如abcd. 在判断是否全是小写的时候。有“.”的话，就返回false，不满足password contains only a~z,0~9,dot。是不是有问题啊 还有判断password contains only a~z,0~9,dot的if代码 非！少了扣号 论单元测试的重要性

课堂讨论： 1. 关于 isValidPassword() 可读性优化： 示例代码中的单行注释已经把验证规则清楚列明，但是必须打开源代码才能看见。我认为可以在函数声明处使用文档注释（即多行注释）对规则进行描述，这样函数的使用者借助 IDE 的代码提示功能就能看到具体的规则，同时也为用工具生成的项目文档提供注释。 2. 关于注释用中文还是英文的问题：对于团队开发，如果有外国人当然要用英文；但是如果只有中国人，我认为最好用中文。首先是每个人的外语水平不一，外语水平好的看到别人的语法错误甚至连单词都拼错，真的很影响心情。对于外语水平不太好的，使用外语写注释不友好且心理压力大，甚至回过头再看都不知道自己当初想表达什么。团队中最重要的是相互合作和最后上线的产品，而不是相互折磨，如果要求使用英文注释会推高沟通成本，那就得不偿失。对于个人项目，选择中英注释均可，但应统一风格。我认为注释只是一个工具，用于降低沟通成本和提醒自己写代码时的思维逻辑和一些关键步骤，但是切不要对这个工具有过高的期望，譬如提高个人甚至团队的外语水平。

我们提倡面向离职写注释

There are only two hard things in Computer Science: cache invalidation and naming things.-- Phil Karlton 命名达意、准确： 不知道如何命名，推荐：Codelf(变量命名神器) https://unbug.github.io/codelf/ Search over projects from Github, Bitbucket, Google Code, Codeplex, Sourceforge, Fedora Project, GitLab to find real-world usage variable names. 关于注释语言： 公司的项目看项目要求（中英文都可以） 自己的个人项目一定要用英文，因为一开始我就考虑到要做国际化的项目（目标是全球用户）。 如何写注释可以多看看JDK源码中的注释，能够学到很多东西。