• Javaweb命名规则


    一、类命名
    命名规范:以大写字母开头,如果有多个单词,每个单词头字母大写。
    例如:StudentInfo

    二、接口命名
    命名规范:以大写字母"I"开头,如果有多个单词,每个单词头字母大写。
    例如:IStudentInfo

    三、接口实现类命名
    命名规范:将实现的接口名称的首字母"I"去掉,以"Impl作为结尾",如果有多个单词,每个单词头字母大写。
    例如:StudentInfoImpl

    四、j2ee框架命名

    除自动生成外,可以命名为:实际含义+框架层名,如:DiaryService等。

    五、类变量命名
    命名规范:变量名首字母必须小写,如果该变量名有多个单词组成,后面的单词首字母大写,单词与单词之间不要使用"_"做连接,变量名访问控制必须为私有, 可以对其增加setter与getter方法。

    例如:

    private int studentAge;
    public int getStudentAge(){
    return studentAge;
    }
    public void setStudentAge(int studentAge) {
    this.studentAge=studentAge;
    }

    六、常量命名
    命名规范:所有字母大写,如果有多个单词组成,单词与单词之间以” _“隔开。而且该变量必须是公共、静态、final类型。
    例如:

    public static final String USER_NAME=”userName“;

    七、方法命名
    命名规范:首字母必须小写,如果该变量名有多个单词组成,后面的单词首字母大写,单词与单词之间不要使用"_"做连接。单词不要使用名词。
    例如:

    public int checkLogin(String name,String pwd){}

    八、注释规范:注释规范是整个开发规范中最为重要的组成部分,必须严格执行。
    1. 类的注释:
    作用:注释整个类,简单概述该类作用。
    书写规范:类的注释必须写在该类的声明语法之前。在注释中要描述该类的基本作用,作者,日期,版本,公司名称,版权声明。
    格式:

    /* * 
    * 类功能描述:(大致描述类的功能) 
    * @author:编写者名称

    * @version: 类文件的版本号 从1.0开始(自己确定版本号的增改 
    * 情况), 修改情况(修改时间、作者、改动情况)
    *
    * @see 包名.参考类名 (列出父类,引入类,每个类占一行),如果有
    * 可省略 
    * 相关数据如:(便于理解本类的一些常量数据及某些数据的格式 
    * 或认为比较重要的数据,如果没有可省略) 
    */ 
    类的声明语法

  • 相关阅读:
    nginx (待更新)
    根据 thread id 停止一个线程
    Redis 消息订阅
    faker smtp server
    DRF lazy Serializer
    python super
    django patch
    django patch 解决 ["'15428560000' value has an invalid format. It must be in YYYY-MM-DD HH:MM[:ss[.uuuuuu]][TZ] format."]
    自己的随笔
    CSS中文乱码解决方法
  • 原文地址:https://www.cnblogs.com/java-xu/p/5882214.html
Copyright © 2020-2023  润新知