day10_1注解

最新推荐文章于 2024-07-16 18:45:22 发布

3w点come

最新推荐文章于 2024-07-16 18:45:22 发布

阅读量115

点赞数

分类专栏： JavaEE

原文链接：https://blog.csdn.net/BennetMa/article/details/102843040?utm_source=app

版权

JavaEE 专栏收录该内容

25 篇文章 0 订阅

订阅专栏

Java注释与注解

注释
注解
- 元注解
- Java API预定义注解

注释

单行注释

//单行注释内容

多行注释

/*
注释内容
*/

文档注释

/**
文档注释内容
*/

使用文档生成工具软件（\JDK安装目录下的\bin\javadoc.exe）自动生成说明文档，减轻程序员编写说明文档的工作量。

例：

package Api;
/**
 * 类功能简介：TEST是一个测试类，添加了文档注释
 * @author PC214
 *
 */
public class TEST {
	private int a,b,c;//私有成员不对外开放，不需要添加文档注释
	/**
	 * get方法
	 * @return
	 */
	public int getA() {
		return a;
	}
	/**
	 * set方法
	 * @param a
	 */
	public void setA(int a) {
		this.a = a;
	}
	/**
	 * toString()方法
	 */
	@Override
	public String toString() {
		return "TEST [a=" + a + ", b=" + b + ", c=" + c + "]";
	}
	/**
	 * 构造方法
	 */
	public TEST(int h,int m,int s) {//构造方法
		a = h; b = m; c = s;
	}

}

生成方式：

在这里插入图片描述

结果：

javadoc标记说明

在这里插入图片描述
注意：javadoc针对public类生成注释文档

注解

用于规范文档注释中的某些关键信息，例如程序作者，方法的参数或返回值等说明信息。
在这里插入图片描述
注解主要用途是在类定义代码中插入附加信息。

元注解

定义在java.lang.annotation包中
在这里插入图片描述

Java API预定义注解

在这里插入图片描述
参考

                                </div>
            <link href="https://csdnimg.cn/release/phoenix/mdeditor/markdown_views-60ecaf1f42.css" rel="stylesheet">
                                <div data-report-view="{&quot;mod&quot;:&quot;popu_387&quot;,&quot;dest&quot;:&quot;https://blog.csdn.net/BennetMa/article/details/102843040&quot;,&quot;extend1&quot;:&quot;pc&quot;,&quot;ab&quot;:&quot;new&quot;}"></div>
                    
        <div class="person-messagebox">
            <div class="left-message"><a href="https://blog.csdn.net/BennetMa">
                <img src="https://profile.csdnimg.cn/1/B/3/3_bennetma" class="avatar_pic" username="BennetMa">
            </a></div>
            <div class="middle-message">
                                    <div class="title"><span class="tit "><a href="https://blog.csdn.net/BennetMa" data-report-click="{&quot;mod&quot;:&quot;popu_379&quot;,&quot;ab&quot;:&quot;new&quot;}" target="_blank">MP-214</a></span>
                    <!-- 等级，level -->
                    <img class="identity-icon" src="https://csdnimg.cn/identity/vip.png">                        <img class="identity-icon" src="https://csdnimg.cn/identity/blog4.png">                                            </div>
                <div class="text"><span>原创文章 78</span><span>获赞 24</span><span>访问量 8541</span></div>
            </div>
                            <div class="right-message">
                                        <a class="btn btn-sm  bt-button personal-watch" data-report-click="{&quot;mod&quot;:&quot;popu_379&quot;,&quot;ab&quot;:&quot;new&quot;,&quot;extend1&quot;:&quot;个人信息未关注&quot;}">关注</a>
                                                            <a href="https://im.csdn.net/im/main.html?userName=BennetMa" target="_blank" class="btn btn-sm bt-button personal-letter">私信
                    </a>
                                </div>
                        </div>
                    
    </div>