一、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 参数a 11 * @return 返回值描述 12 * @throws 异常说明 13 */ 14 public int test(int a) throws Exception{ 15 return a; 16 }
我觉得很多细节还需要学习,天天学习,天天进步!
参考:https://hacpai.com/article/1402537988442
时间: 2024-10-26 21:24:52