您当前的位置： 首页 > 慢生活 > 程序人生 网站首页程序人生

12_注解_概念

发布时间：2022-07-05 22:26:09编辑：雪饮阅读（）

 今天所涉及的几个注解概念的一个示例：


今天这里首先第一个概念是Override注解，该注解表示被注解的方法必须是覆写父类的方法，否则该驻注解就会编译时报错。
那么若生成了doc文档则是长这样

比如这里你修改toString方法名为toString2就不对了。
这第二个注解是写在方法前用于注解该方法的形参及返回值
这里需要注意的是第一个反斜杠后面必须是两个“*”号，且param后面跟上控告然后是形参名称（这里没有仔细测试，但觉得这样规范些），然后再跟上空格然后是该形参的解释。而param前面和当前行的“*”号应该也是有一个空格的（这里没有仔细测试，但觉得这样规范些）。
然后该方法的主要功能就直接写在两个“*”号的下一行，这里我同样在下一行行首有距离一个空格（这里没有仔细测试，但觉得这样规范些）。
那么生成后的doc文档呈现如：

这第三个注解就是类名前面的注解了，这个和方法的注解差不多，只是这里（也可能只是当前这一节课程中没有用到）没有用到param，而是用到了
author标记作者，version标记版本, since标记用于声明一个版本号，表示从该版本号之后则被注解的对象才能用。
那么呈现为：

就是作者和版本号没有看到。
 
那么最后说下这个生成doc文档可以使用命令如：
C:\Users\Administrator\IdeaProjects\untitled\src\day1\annotation>javadoc -encoding utf8 index.java
正在加载源文件index.java...
正在构造 Javadoc 信息...
标准 Doclet 版本 1.8.0_171
正在构建所有程序包和类的树...
正在生成.\day1\annotation\index.html...
正在生成.\day1\annotation\package-frame.html...
正在生成.\day1\annotation\package-summary.html...
正在生成.\day1\annotation\package-tree.html...
正在生成.\constant-values.html...
正在构建所有程序包和类的索引...
正在生成.\overview-tree.html...
正在生成.\index-all.html...
正在生成.\deprecated-list.html...
正在构建所有类的索引...
正在生成.\allclasses-frame.html...
正在生成.\allclasses-noframe.html...
正在生成.\index.html...
正在生成.\help-doc.html...
那么最后贴出本节的源代码：

package day1.annotation;
/**
* 注解javadoc演示类
* @author kasumi
* @version 1.0
* @since 1.8
 */
public class index {
    /**
    * 计算两数的和
    * @param a 整数
    * @param b 整数
    * @return 两数的和
     */
   public int add(int a,int b){
       return a+b;
   }
   @Override
   public String toString(){
       return "";
   }
}