注释和JavaDoc

注释

单行

//注释内容

多行

/*
注释内容
*/

文档注释

/**
注释内容
@Description：描述
@Auther：作者
*/

JavaDoc

用来生成自己的API文档
生成api文档命令：javadoc -encoding utf-8 -charset utf-8 java文件

参数信息

可在方法或类上

• @author 作者名
• @version 版本号
• @since 最早使用的jdk版本
• @parm 参数名
• @return 返回值情况
• @throws 异常抛出情况