全栈技术学习

(零)java 注释 规则

2019-05-11  本文已影响0人  Mando度

规则

1.包名

小写cn.itcast.test

2.类名和接口名

首字母大写 ArrayList

3.常量名

字母都大写下划线连接DAY_OF_MONTH

4.变量名 方法名 标识符

首字母小写,往后每个单词首字母大写


26.jpg

注释文档

1.常用

/*
 * @author 文档作者
 * @version 版本号
 * @param 用于对方法的说明,表示方法定义的参数以及参数对应说明
 * @return 方法返回值
 * @description 描述
 * */

2.不常用

/*
 * @deprecated 指名一个过期的类或成员
 * @docRoot 指明当前文档根目录的路径
 * @exception 标志一个类抛出的异常
 * @inheritDoc 从直接父类的注释
 * @link 插入一个到另一个主题的链接
 * @linkplain 插入一个到另一个主题的链接,但是该链接显示纯文本字体
 * @see 指定一个到另一个主题的链接
 * @serial 说明一个序列化属性
 * @serialData 说明通过writeObject( ) 和 writeExternal( )方法写的数据
 * @serialField 说明一个ObjectStreamField组件
 * @since 标记当引入一个特定的变化时
 * @throws 标志一个类抛出的异常 和 @exception标签一样.
 * @value 显示常量的值,该常量必须是static属性
 * */

上一篇下一篇

猜你喜欢

热点阅读