Java基础之命名规范的详解

前言

在编程的世界里，每种语言都有自己的一些规范。下面，就带你了解Java命名规范。对于程序员来说，如果想学好一门语言，想要自己写出来的代码能被他人轻易地读懂，深入的学习命名规范是非常必要的一件事情。在这里，总结了一下Java的命名规范。

一、Java命名规范：

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) 坚决不允许出现中文或拼音命名;

二、Java注释规范：

1、 类注释

在每个类前面必须加类注释，注释模板如下：

/**

* Copyright ©, 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 异常类型.错误代码 注明从此类方法中抛出异常的说明

*/

即：

到此这篇关于Java基础之命名规范的详解的文章就介绍到这了,更多相关Java命名规范内容请搜索我们以前的文章或继续浏览下面的相关文章希望大家以后多多支持我们！

赞 (0)

相关推荐

  • 美化java代码，从合理注释开始

    请停止代码注释 "干净的代码应该像写好的散文一样" - Robert C. Martin 不良代码的通病就是有很多注释.这是凌乱的源代码最明显的迹象. 每个程序员的目标应该是编写干净和富有表现力的代码,以避免代码注释.每个变量,函数和类的目的应该隐含在其名称和结构中. 当其他人读取您的代码时,他们不应该阅读注释以了解你的代码正在做什么.命名良好的类和函数应该引导读者通过你的代码,就像一本写得很好的小说一样.当读者看到一个新的类或功能时,他们不应该对他们在里面看到的东西感到困惑难以理解.

  • 解决阿里代码规范检测中方法缺少javadoc注释的问题

    一.问题描述 安装了阿里代码检测的插件后,敲一个简单的方法,发现提示有问题,如下 /** * 查找User的集合 */ List<User> findAll(); 提示信息为: 方法[findAll]缺少javadoc注释 进一步查看完整文档里面关于方法注释的规范为 所有的抽象方法(包括接口中的方法)必须要用javadoc注释.除了返回值.参数.异常说明外,还必须指出该方法做什么事情,实现什么功能. 说明:如有实现和调用注意事项,请一并说明. /** * fetch data by rule

  • java开发中使用IDEA活动模板快速增加注释的方法

    java开发中使用IDEA活动模板快速增加注释的方法

    在java开发中,类.接口.方法,都需要进行注释,注释内容如图: 注释中的基本元素有:描述.作者.创建日期.可增加元素有:修改日期.修改内容.业务详情.参数列表与描述.返回值列表与描述等.使用IDEA增加活动模板,可快速在代码中加入注释,进入[文件]->[设置]->[编辑器]->[活动模板] 在user分类下新增模板为**,点击[编辑变量],增加注释中所使用到的变量即可.变量也可以根据下方函数内容指定.如下图: 设置完毕后,在代码中输入**后敲回车即可生成模板文本中的内容,注释则先输入/

  • 详解IDEA自定义注释模板(javadoc)

    最近要开始做项目了,项目规定了方法注释模板,那么idea是如何自定义注释模板的呢? 有两种解决方案: 1.安装Jindent插件,好处是自动生成模板,但是很可惜本人安装失败,设置好以后不知道为什么无法Apply,可能是我的版本问题,失败的同学请看方案二. 2.Jindent插件下载:http://plugins.jetbrains.com/plugin/2170?pr=idea,也可以直接在idea中在线安装,类似eclipse的在线install2.使用idea自带的Live Template

  • Java注释代码执行方法解析

    直接上代码: @Test public void testUnicode() { String a = "Hello"; // \u000d a="world"; System.out.println(a); // \u000a a="hello world!"; System.out.println(a); } 猜一猜,最后会输出什么? world hello world! 是的,没看错,那二行看似"注释掉的代码",被执行了

  • Java命名规范

    编写规范目的:能够在编码过程中实现规范化,为以后的程序开发中养成良好的行为习惯. 1. 项目名全部小写 2. 包名全部小写 3. 类名首字母大写,如果类名由多个单词组成,每个单词的首字母都要大写. 如:public class MyFirstClass{} 4. 变量名.方法名首字母小写,如果名称由多个单词组成,每个单词的首字母都要大写.(驼峰式) 如:int index=0; public void toString(){} 5. 常量名全部大写 如:public static final S

  • Javadoc标签和Javadoc注释规范说明

    最近看源码,一些Javadoc常见的注释整理下 Javadoc是Sun公司提供的一个技术,从程序源代码中抽取类.方法.成员等注释形成一个和源代码配套的API帮助文档. Javadoc命令是用来生成自己的API文档,使用方式: javadoc 源文件名.java javadoc -d 文档存放目录 源文件名.java 通过IDEA生成Javadoc : Tools -> Generate JavaDoc javadoc标签 标签 说明 @author 作者标识 @version 版本号 @retu

  • eclipse/intellij idea 查看java源码和注释方法

    工作三年了,一直不知道怎么用IDE查看第三方jar包的源码和注释,惭愧啊!看源码还好些,itellij idea自带反编译器,eclipse装个插件即可,看注释就麻烦了,总不能去找api文档吧!现在终于掌握了,下面给出解决方案,供大家参考,以提升开发学习效率! eclipse 1.下载源码包 1.1 去官网下载 1.2 去maven仓库下载( 例如:maven mysql 百度一下,肯定会出现仓库地址,找某一个版本下载即可) 1.3 maven命令下载(适用maven项目),在pom.xml文件

  • Java的文档注释之生成帮助文档的实例

    Java的文档注释之生成帮助文档的实例

    示例: /** * Title: Person类<br/> * Description:通过Person类说明Java中的文档注释<br/> * Company: *** * @author *** * @version 1.0 */ public class Person { /** * 这个是Person类的构造方法 * @param name Person 的名字 * */ public Person(String name) { //执行语句: } /** * 这是read

  • Java项目开发命名规范(动力节点Java学院整理)

    最好使用英文,不要用汉语拼音 1:包(package):用于将完成不同功能的类分门别类,放在不同的目录(包)下,包的命名规则:将公司域名反转作为包名.比如www.bjpowernode.com 对于包名:每个字母都需要小写.比如:com. bjpowernode.test;该包下的Test类的全名是:com. bjpowernode.Test.java .如果定义类的时候没有使用package,那么java就认为我们所定义的类位于默认包里面(default package). 2:类:首字母大写

  • java 基础之JavaBean属性命名规范问题

    java 基础之JavaBean属性命名规范问题 JavaBean属性名要求:前两个字母要么都大写,要么都小写 下面我们来找找如果不遵循这个规范是个什么样子?? 因为本人还没有用反射来通过不规范的属性名来查找相应的属性值,所以以下的结论都是我的猜测.如果有错误欢迎大家来指正!!! package com.domain; import java.beans.BeanInfo; import java.beans.Introspector; import java.beans.PropertyDes

  • java开发命名规范总结

    使用前注意事项:1.由于Java面向对象编程的特性, 在命名时应尽量选择名词 2.驼峰命名法(Camel-Case): 当变量名或函式名是由一个或多个单字连结在一起,而构成的唯一识别字时,首字母以小写开头,每个单词首字母大写(第一个单词除外). 如:myFirstName 一 包名的书写规范 (Package)推荐使用公司或机构的顶级域名为包名的前缀,目的是保证各公司/机构内所使用的包名的唯一性.包名全部为小写字母,且具有实际的区分意义. 1.1 一般要求1.选择有意义的名字,能快速地传达该类的

随机推荐