java api接口文档怎么编写?

Python010

java api接口文档怎么编写?,第1张

Java语言提供了一种强大的注释形式:文档注释。可以将源代码里的文档注释提取成一份系统的API文档。我们在开发中定义类、方法时可以先添加文档注释,然后使用javadoc工具来生成自己的API文档。

文档注释以斜线后紧跟两个星号(/**)开始,以星号后紧跟一个斜线(*/)作为结尾,中间部分全部都是文档注释,会被提取到API文档中。

自行搜索一下javadoc即可,示例如下:

1234567891011121314151617181920212223242526272829/** * 类描述 * * @author 作者 * @version 版本 */public class DemoClass {    /**     * 内部属性:name     */    private String name          /**     * Setter方法     * @return name     */    public String getName() {        return name   }     /**     * Getter方法     * @param name     */    public void setName(String name) {        this.name = name   } }

在我们开发中,对于任何操作,信息中时间是非常重要的一点,我们可以根据时间判断发生的时间,时间可以记录非常重要的信息

在Java中,专门给我们提供了处理时间的API,根据Java封装的时间类,我们可以很方便的操作时间信息

在处理时间的时候,有个概念我们经常会用到,就是时间戳,时间戳表示的是从1970年01月01日00时00分00秒起至现在的总毫秒数,我们可以将时间戳与时间进行随意的替换

Java中处理时间的类是java.util.Date,这个类有常用的两个构造方法,一个是无参的获取的当前时间的对象,一个是出入一个时间戳,获取该时间戳对应的时间,JDK中这个类还提供了一些其他的构造方法,比如传入年月日等多个参数获取对应的时间,但是这些构造方法JDK中已经不建议使用了,需要注意的是,使用年月日参数(过时的构造方法)创建对象的时候,传入的年的参数需要减去1900,因为JDK中默认处理将年份增加了1900

Java中还提供了一个类SimpleDateFormat可以方便我们将Date与字符串进行转换,Date类中重写了toString方法,所以当打印date的时候,会按照重写的格式进行打印,但是有时候我们需要定义自己的格式进行输入输出,这时候就可以使用SimpleDateFormat类来进行自定义

创建SimpleDateFormat对象的时候,需要传入一个参数,我们可以按照自己想要的格式进行编写,例如”yyyy-MM-dd hh:mm:ss:SSS”, 这样输出的格式就会是年-月-日 时:分:秒我们可以随意调整打印的顺序与格式其中yyyy表示年份,MM表示月份(大写),dd表示日期,hh表示小时,mm表示分钟(小写),ss表示秒(小写),SS表示毫秒(大写)除了这些格式外,还可以打印到时区,周几,一周第几天等信息

除了可以将时间对象转换成字符串,SimpleDateFormat也可以将字符串转按照相应的格式成对应的时间