「java注解生成api」java生成文档注释
今天给各位分享java注解生成api的知识,其中也会对java生成文档注释进行解释,如果能碰巧解决你现在面临的问题,别忘了关注本站,现在开始吧!
本文目录一览:
java api接口文档怎么编写?
Java语言提供了一种强大的注释形式:文档注释。可以将源代码里的文档注释提取成一份系统的API文档。我们在开发中定义类、方法时可以先添加文档注释,然后使用javadoc工具来生成自己的API文档。
文档注释以斜线后紧跟两个星号(/**)开始,以星号后紧跟一个斜线(*/)作为结尾,中间部分全部都是文档注释,会被提取到API文档中。
自行搜索一下javadoc即可,示例如下:
1234567891011121314151617181920212223242526272829/** * 类描述 * * @author 作者 * @version 版本 */public class DemoClass { /** * 内部属性:name */ private String name; /** * Setter方法 * @return name */ public String getName() { return name; } /** * Getter方法 * @param name */ public void setName(String name) { this.name = name; } }
java注解是怎么实现的
1、构造方法上加注解和普通方法加注解是一样的在构造方法定义前加 @注解类型就像行了。
public class Car {
@Deprecated
public Car() {
}
}
2、java语义规定注解类不能定义构造方法。可以使用default 关键字规定默认值,规定了默认值在使用时就可以省略属性赋值。
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@Documented
@Inherited
public @interface Auth {
/**
* 是否验证登陆 true=验证 ,false = 不验证
* @return
*/
public boolean verifyLogin() default true;
/**
* 是否验证URL true=验证 ,false = 不验证
* @return
*/
public boolean verifyURL() default true;
}
怎么把Java源代码封装成api的形式
源代码应该是写在一个类里边的,通过myeclipse或者是eclipse来打包成jar包,
然后把jar包导入到项目工程中,
直接写类名,然后会提示导入该类所属的包,这样就可以的噢。
平时的源码封装和使用是这样子的。
java注解生成api的介绍就聊到这里吧,感谢你花时间阅读本站内容,更多关于java生成文档注释、java注解生成api的信息别忘了在本站进行查找喔。