当前位置: 首页 > news >正文

Java项目命名规范

2019独角兽企业重金招聘Python工程师标准>>> hot3.png

一、命名规范


1、 项目名全部小写


2、 包名全部小写


3、 类名首字母大写,如果类名由多个单词组成,每个单词的首字母都要大写。


如:public class MyFirstClass{}


4、 变量名、方法名首字母小写,如果名称由多个单词组成,每个单词的首字母都要大写。


如:int index=0;


       public void toString(){}


5、 常量名全部大写


如:public static final String GAME_COLOR=”RED”;


6、所有命名规则必须遵循以下规则:


1)、名称只能由字母、数字、下划线、$符号组成


2)、不能以数字开头


3)、名称不能使用JAVA中的关键字。


4)、坚决不允许出现中文及拼音命名。


 


二、注释规范


1、   类注释


在每个类前面必须加上类注释,注释模板如下:


/**


* Copyright (C), 2006-2010, ChengDu Lovo info. Co., Ltd.


* FileName: Test.java


* 类的详细说明


*


* @author 类创建者姓名

    * @Date    创建日期


* @version 1.00


*/


 


2、   属性注释


在每个属性前面必须加上属性注释,注释模板如下:


/** 提示信息 */


private String strMsg = null;


 


3、   方法注释


在每个方法前面必须加上方法注释,注释模板如下:


/**


* 类方法的详细使用说明


*


* @param 参数1 参数1的使用说明


* @return 返回结果的说明


* @throws 异常类型.错误代码 注明从此类方法中抛出异常的说明


*/


4、   构造方法注释


在每个构造方法前面必须加上注释,注释模板如下:


/**


* 构造方法的详细使用说明


*


* @param 参数1 参数1的使用说明


* @throws 异常类型.错误代码 注明从此类方法中抛出异常的说明


*/


 


5、   方法内部注释


在方法内部使用单行或者多行注释,该注释根据实际情况添加。


如://背景颜色


       Color bgColor = Color.RED


转载于:https://my.oschina.net/u/2350638/blog/656256

相关文章:

  • 对Python进程进行全解析
  • KeyMob,专注于移动广告聚合平台
  • 利用php.ini隐藏一句话
  • iOS开发之遍历Model类的属性并完善使用Runtime给Model类赋值
  • html中块注释!--[if IE]….![endif]-- (!--[if !IE]||![endif]
  • 在CentOS7部署zookeeper集群以及简单API使用
  • Spring3.0核心组件的源码简单分析
  • 核心动画——弹簧动画二
  • 不能修改数据
  • 春招面试小记
  • poj 3468(线段树+lazy思想)
  • 算法系列15天速成——第五天 五大经典查找【中】
  • Mac OS 安装phpMyAdmin
  • 用PHP抓取淘宝商品的用户晒单评论+图片实例
  • c语言小练习(蛮好玩的)
  • [译]如何构建服务器端web组件,为何要构建?
  • Docker入门(二) - Dockerfile
  • happypack两次报错的问题
  • Java应用性能调优
  • java中具有继承关系的类及其对象初始化顺序
  • Python - 闭包Closure
  • Traffic-Sign Detection and Classification in the Wild 论文笔记
  • vue-router的history模式发布配置
  • 机器人定位导航技术 激光SLAM与视觉SLAM谁更胜一筹?
  • 开源SQL-on-Hadoop系统一览
  • 开源中国专访:Chameleon原理首发,其它跨多端统一框架都是假的?
  • 入门级的git使用指北
  • 适配iPhoneX、iPhoneXs、iPhoneXs Max、iPhoneXr 屏幕尺寸及安全区域
  • 运行时添加log4j2的appender
  • 在Unity中实现一个简单的消息管理器
  • 最简单的无缝轮播
  • HanLP分词命名实体提取详解
  • Java数据解析之JSON
  • puppet连载22:define用法
  • Semaphore
  • UI设计初学者应该如何入门?
  • 阿里云ACE认证学习知识点梳理
  • 移动端高清、多屏适配方案
  • ​Distil-Whisper:比Whisper快6倍,体积小50%的语音识别模型
  • ​用户画像从0到100的构建思路
  • #Spring-boot高级
  • #大学#套接字
  • #经典论文 异质山坡的物理模型 2 有效导水率
  • (C语言)strcpy与strcpy详解,与模拟实现
  • (NO.00004)iOS实现打砖块游戏(九):游戏中小球与反弹棒的碰撞
  • (zt)基于Facebook和Flash平台的应用架构解析
  • (分享)自己整理的一些简单awk实用语句
  • (七)c52学习之旅-中断
  • (十八)SpringBoot之发送QQ邮件
  • ***监测系统的构建(chkrootkit )
  • *ST京蓝入股力合节能 着力绿色智慧城市服务
  • .NET 5种线程安全集合
  • .net Application的目录
  • .NET Core跨平台微服务学习资源
  • .NET Core使用NPOI导出复杂,美观的Excel详解