Java入门必看,编程命名的规范

一、命名规范

  1. (除了配置文件之外)所有的命名中均只能包含字母、数字、下划线"_"
  2. 包名的命名规范:
    1. 全部为小写字母
    2. 一般为公司域名反写开头,例如: com.baidu.tieba
  3. 类名或者接口名,均要求大写字母开头,如果是多个单词,则采用驼峰命名法,例如:UserService
  4. 方法名一般为动词或者动词词组,均要求小写字母开头,如果是多个单词则采用驼峰命名法,例如: findById()
  5. 变量名均要求以小写字母开头,如果是多个单词,则采用驼峰命名法,例如: userInfo;变量名要求尽量精简,而且要具备可读性
  6. 常量全部为大写字母,每个单词之间用"_"连接,例如USERNAME_SESSION_KEY

二、注释规范

  1. 每一个类的开头,应该具备一个注释,用于描述作者、日期时间、以及类的功能
  2. 每一个方法都必须添加文档注释,用于描述方法的具体功能、参数、返回值等等信息
  3. 类的成员变量,使用"//"注释描述成员变量
  4. 稍微复杂的流程,使用"//"注释描述代码的流程步骤
  • 0
    点赞
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值