【277天】每日项目总结系列015(2017.11.09)

叨叨两句

  1. ~web

Java命名规范

全局规范

  1. 在Java中,原则上不要出现中文。一般只有大写字母、小写字母、_、$、数字。this

  2. 一般不会用数字开头。code

  3. 命名一般要有意义(见名知意)。接口

  4. 不要使用关键字。class,this。ci

项目命名规范

  1. 原则上,项目名用由小写字母(能够包含数字)组成。文档

包名

  1. 原则上,由小写字母构成,能够出现数字。get

  2. 格式:公司域名倒过来写+项目名字。
    例如:www.baidu.com + demo
    com.baidu.demo
    com.baidu.demo.bean
    com.baidu.demo.utils
    com.baidu.demo.web.servletservlet

类名(接口)

  1. (驼峰命名法)首字母大写,其他小写;若是类名中有多个单词,那么每个单词的首字母都大写。域名

  2. 原则上必须见名知意。类名必需要有意义,尽可能用英文单词表示,遇到不懂的,查词典。尽可能避免出现AAA,BBB,ABC之类的。io

  3. 例如:Teacher,DriverManager,JDBC4Connection。

  4. 部分人习惯

    1. 在接口前加I,例如IBinder。

    2. 若是某一个类做为接口的默认实现类,会在接口后面加上Impl:UserDao(接口)->UserDaoImpl(接口的默认实现类)。

方法和变量

  1. (小驼峰命名法)首字母小写,其他字母小写;若是变量或者方法名中出现多个单词,那么除了第一个单词之外,其余单词的首字母都大写。

getName,getConnection,toString,createStatment;size,decimalSeparator。
  1. 原则上必须见名知意。类名必需要有意义,尽可能用英文单词表示,遇到不懂的,查词典。尽可能避免出现AAA,BBB,ABC之类的。

  2. 部分人的习惯

    1. 成员变量一部分人喜欢在前面加m,mSize,mDecimalSeparator。

    2. 静态变量前面加s,sSize,sDecimalSeparator。

常量

  1. 全部单词的每一个字母所有大写,单词和单词之间用_隔开。

  2. 例如KEY_DOWN,MAX_VALUE。

  3. final static修饰别忘。

注释(三种写法)

  1. 文档注释(出如今一些比较正规的项目中,写在类或者方法的上面)

/**
     *    做者:xxx
     *    参数:方法中每一个参数的含义
     *    返回值:返回值的含义
     */
  1. 单行注释

//这是单行注释。
  1. 多行注释

/*
        多行注释1
        多行注释2
    */