理论五(上):让你最快速地改善代码质量的18条编程规范(命名与注

2020-11-28  本文已影响0人  _River_

1:命名多长比较合适?

    熟悉的词尽量缩写,作用域比较小的函数也可以用比较短的命名:方法里面的临时变量

2:利用上下文简化命名

    类的熟悉名:User类里面的 userName -> name     userPassword->password

    方法参数名:

                    public void uploadUserAvatarImageToAliyun(String userAvatarImageUri);

                    //利用上下文简化为:

                    public void uploadUserAvatarImageToAliyun(String imageUri);

3:命名可读,可搜索

    可读:发音不要特别奇怪

    可搜索:对象.get 获取该对象所有get方法    

              项目中都用select就不要用query  都用insert就不要用add

4:如何命名接口和抽象类:

    接口:接口  使用 IUserService  实现用 UserService

               接口 使用  UserService   实现用 UserServiceImpl

    抽象类:前缀带Abstract  如 AbstractConfiguration

5:注释该写什么?

   为什么? 做什么?  怎么做?  (如何用?)

    做什么和怎么做  都可以  在代码中体现  但并不完整和准确

    比较复杂的代码逻辑里面小模块尽量使用总结性注释

6:注解是不是越多越好?

    类与方法尽量详细,而方法内部依靠好的命名,提炼代码块,解释性变量,总结性代码,尽量减少注解。

上一篇下一篇

猜你喜欢

热点阅读