java文档注释主要使用方法
来源:互联网 发布:绿化效果图制作软件 编辑:程序博客网 时间:2024/05/17 00:51
一、java包含哪些注释
1.//用于单行注释。
2./*...*/用于多行注释,从/*开始,到*/结束,不能嵌套。
3./**...*/则是为支持jdk工具javadoc.exe而特有的注释语句。这个也就是我们所知的文档注释
在命名控制台:使用命令行在目标文件所在目录输入javadoc +文件名.java。
二、文档注释的关键名词
/**<p>标记 用于 作用</p> * @author 类或方法 一般用于描述开放者 * @version 类 版本说明 * @see 对类、属性、方法的说明 参考转向,也就是相关主题 * @param 方法 对方法参数的说明 * @throws 方法 对异常的说明 * @return 方法 对返回值的说明 * {@value} 方法,类 、属性 可以用于生成被标记的常量字段的值。 * {@inheritDoc} 方法、类 可以集成上一个文档的注释 * {@link} 类、方法 链接标签 * {@linkplain} 类、方法 链接标签、与上一个标签唯一的不同就是因为字体不同,如果 label 是个纯文本,那就使用 linkplain * @since 类、方法 表达的是被标记元素是哪个发布版本引入的 * @exception 方法 跟@throws的用法相同 * @serialData * <pre> 方法、类 没错,这就是那个 HTML 标签,用于显示“原始样子”的。 */
三、一个例子
1 public void aa(){ 2 3 } 4 5 6 /**一般这几个注解够开放使用了 7 * @author mingge 8 * @since 1.0 9 * @see #aa() 查看aa方法10 * @param a 参数a11 * @return 返回值描述12 * @throws 异常说明13 */14 public int test(int a) throws Exception{15 return a;16 }
我觉得很多细节还需要学习,天天学习,天天进步!
阅读全文
0 0
- java文档注释主要使用方法
- Javadoc文档注释使用方法
- Javadoc文档注释使用方法
- Java注释及文档注释
- JAVA 文档注释--JAVADOC文档
- JAVA 文档注释
- java文档注释
- java文档注释
- Java文档注释说明
- java注释文档
- Java文档注释方法
- Java 文档注释
- java文档注释
- Java文档注释摘要
- java注释文档
- JAVA文档注释小结
- java文档注释
- Java文档注释
- Java Web 中使用Mybatis开发的步骤
- 脉搏波信号处理
- 适合小白的大白话讲解--->Git与Github的区别
- 电脑安装Mysql数据库
- Webservice 底层调用的本质
- java文档注释主要使用方法
- JS判断是IOS还是Android
- 检测Linux VPS是Xen、OpenVZ还是KVM架构的方法 判断VPS是Xen、OpenVZ还是KVM真假的方法
- bind()详解
- pageContext对象的用法
- multiple input paths are not supported for libsvm data
- 栈 判断回文序列
- 移动办公OA行业的普及推动力——泛微三季报披露
- 解密Airbnb 自助BI神器:Superset