Java~命名规范
2024-10-19 04:15:16
下面总结以点java命名规范
虽然感觉这些规范比起C#来说有点怪,但还是应该尊重它的命名!
命名规范
- 项目名全部小写
- 包名全部小写
- 类名首字母大写,如果类名由多个单词组成,每个单词的首字母都要大写。
- 变量名、方法名首字母小写,如果名称由多个单词组成,每个单词的首字母都要大写。
- 常量名全部大写
- 所有命名规则必须遵循以下规则:
*. 名称只能由字母、数字、下划线、$符号组成
*. 不能以数字开头
*. 名称不能使用JAVA中的关键字。
*. 坚决不允许出现中文及拼音命名。
注释规范
1 类注释
在每个类前面必须加上类注释,注释模板如下:
/**
* 类的详细说明
*
* @author 类创建者姓名
* @Date 创建日期
* @version 1.00
*/
2 属性注释
在每个属性前面必须加上属性注释,注释模板如下:
/** 提示信息 */
private String strMsg = null;
3 方法注释
在每个方法前面必须加上方法注释,注释模板如下:
/**
* 类方法的详细使用说明
*
* @param 参数1 参数1的使用说明
* @return 返回结果的说明
* @throws 异常类型.错误代码 注明从此类方法中抛出异常的说明
*/
4 构造方法注释
在每个构造方法前面必须加上注释,注释模板如下:
/**
* 构造方法的详细使用说明
*
* @param 参数1 参数1的使用说明
* @throws 异常类型.错误代码 注明从此类方法中抛出异常的说明
*/
5 方法内部注释
在方法内部使用单行或者多行注释,该注释根据实际情况添加。
//背景颜色
int init =1;
待续...
最新文章
- 502 Bad Gateway深究
- 水平时间轴 html + css
- 弹出框三 之 sweetalert
- css3,background-clip/background-origin的使用场景,通俗讲解
- 【niubi-job——一个分布式的任务调度框架】----如何开发一个niubi-job的定时任务
- Enum 绑定到 RadioButton
- Readonly和disabled的区别 display:none和visible:hidden的区别
- 代码片段 - Golang 实现集合操作
- iOS UIView常用方法和属性
- 【WCF--初入江湖】13 实战
- iOS开发中xib和Storyboard中需要注意的事项
- 苹果Swift编程语言新手教程【中文版】
- SpringMVC+Mybatis实现的Mysql分页数据查询
- js随机生成验证码及其颜色
- spring通知执行的顺序
- Git问题总结
- xss挑战之旅wp
- Ubuntu下安装Kafka Manager
- 将一个浮点数转换成人民币读法字符串(java)
- Windows 常识大全【all】