java类注释_Java注释，java类注释详解

一个程序的可读性，关键点就在于注释，下面要给大家讲到的就是Java注释方面的知识，主要会介绍java类注释

类注释一般必须放在所有的“import”语句之后，类定义之前，主要声明该类可以做什么，以及创建者、创建日期、版本和包名等一些信息。

下面的话就是一个类注释的模板：/**

* @projectName(项目名称): project_name

* @package(包): package_name.file_name

* @className(类名称): type_name

* @description(类描述): 一句话描述该类的功能

* @author(创建人): user

* @createDate(创建时间): datetime

* @updateUser(修改人): user

* @updateDate(修改时间): datetime

* @updateRemark(修改备注): 说明本次修改内容

* @version(版本): v1.0

注意一下，上面以@开头的标签为Javadoc标记，由@和标记类型组成，缺一不可，@和标记类型之间有的时候可以用空格符分隔，但是不推荐用空格符分隔，因为这样非常容易出现错误。

一个类注释的创建人、创建时间和描述都是不能够少的。

下面的话就是一个类注释的例子：/**

* @author: zhangsan

* @createDate: 2018/10/28

* @description: this is the student class.

public class student{

.................

}

同时要注意一下，没有必要在每一行的开始用*，例如，下面的注释同样是合法的：/**

@author: zhangsan

@createDate: 2018/10/28

@description: this is the student class.

public class student{

.................

}

对于类注释就为你介绍到这里了，希望上面的内容可以帮助到你，更多java基础知识，请继续来奇Q工具网了解学习吧。

java类注释_Java注释，java类注释详解相关推荐

java 类参数_Java的数据类型和参数传递(详解)
Java提供的数据类型主要分为两大类:基本数据类型和引用数据类型. Java中的基本数据类型名称大小取值范围 byte型 (字节) 8bit -128-127 (-2^7到2^7-1) shor ...
java多线程教程_java 基础教程之多线程详解及简单实例
java 多线程详解在这篇文章里,我们关注多线程.多线程是一个复杂的话题,包含了很多内容,这篇文章主要关注线程的基本属性.如何创建线程.线程的状态切换以及线程通信. 线程是操作系统运行的基本单位,它 ...
java局部内部类_Java 局部内部类、匿名内部类详解
外部类与内部类众所周知,每个java文件必须有一个与这个java文件同名的外部类,这个外部类可以是public或default的.而除了这个同名外部类,还可以有与这个同名外部类平级的其他外部类,但它 ...
java闭合数据_java多线程中线程封闭详解
线程封闭的概念访问共享变量时,通常要使用同步,所以避免使用同步的方法就是减少共享数据的使用,这种技术就是线程封闭. 实现线程封闭的方法 1:ad-hoc线程封闭这是完全靠实现者控制的线程封闭,他的 ...
java lombok 视频_Java开发神器Lombok使用详解
最近正在写SpringBoot系列文章和录制视频教程,每次都要重复写一些Getter/Setter.构造器方法.字符串输出的ToString方法和Equals/HashCode方法等.甚是浪费时间,也 ...
java静态多态_Java静态方法不具有多态性详解
动态绑定机制使得基类的引用能够指向正确的子类对象,从而使得面向基类编程成为可能. 然而动态绑定在以下两种情况会失效. 1.基类方法是private或final修饰的这个很好理解,因为private说 ...
java observer模式_Java观察者模式（Observer）详解及应用
Java观察者模式(Observer)详解及应用 (2011-12-15 14:03:30) 标签: 杂谈 Java观察者模式(Observer)详解及应用由于网站带有弱sns功能,因此需要设计关注 ...
java 并发组件_Java 并发计数组件Striped64详解
作者: 一字马胡转载标志 [2017-11-03] 更新日志日期更新内容备注 2017-11-03 添加转载标志持续更新 Java Striped64 Striped64是在java8中添加 ...
java ipv6校验_Java对IPv6的支持详解：支持情况、相关API、演示代码等
本文由朱益盛.杨晖.傅啸分享,来自IBM Developer社区,原题"使用 Java 开发兼容 IPv6 的网络应用程序",本次收录时有改动. 1.引言前几天,有个群友跟我讨论 ...
java 静态导入_JAVA静态导入(import static)详解
在Java 5中,import语句得到了增强,以便提供甚至更加强大的减少击键次数功能,虽然一些人争议说这是以可读性为代价的.这种新的特性成为静态导入. 当你想使用static成员时,可以使用静态导入 ...

java类注释_Java注释，java类注释详解

java类注释_Java注释，java类注释详解相关推荐

最新文章

热门文章