Java中的命名规范和注释

命名规范

在学习规范之前需要先了解一种法则——驼峰法则(所有字母小写,每个单词的首字母大写)

驼峰法则法则分为两种:
小驼峰法则:第一个单词首字母小写,其他单词首字母大写,例如:javaStudy
大驼峰法则:所有单词的首字母大写。例如:JavaStudy
项目名:全部小写
包名:全部小写
类、接口名:大驼峰法则,每个单词第一个字母大写
方法名:小驼峰法则
变量名:小驼峰法则
常亮:所有单词的所有字母大写

不建议使用拼音命名

注释

代码注释

单行注释: 在要注释的代码前书写// 例如://单行代码
多行注释: 在需要注释的代码前书写/*,在结束的位置书写*/ 例如:/*这里面是多行代码*/

文档注释

类注释
/**
* @Author  类创建者姓名
* @Date    创建日期
* @Version 版本
* @Description 类的描述
*/
方法注释
/**
* @Param 参数说明,可以有多个
* @Return 返回结果的说明
* @Throws 异常类型.错误代码 注明从此方法中抛出异常的说明
* @Description 方法的详细介绍
*/
属性注释
/**名字*/
private String name;

注意,Java中所有的标点符号都是英文的,特别是0和o、1和l

转载请注明:https://blog.grstudy.com/java/note/11
免责声明&联系方式

标签: Java 笔记

作者头像
boss创始人

站长

上一篇:Java中的数据类型
下一篇:Java当中的运算符