java文档注释主要使用方法

一、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

java文档注释主要使用方法的相关文章

java文档注释 编写格式

java 文档注释 在sun主页上有java文档注释的编写格式 How to Write Doc Comments for the Javadoc Tool http://java.sun.com/j2se/javadoc/writingdoccomments/ 不过是英文的 @author dfeixtay @version 0.10 2010-10-04 1 注释文档的格式注释文档将用来生成HTML格式的代码报告,所以注释文档必须书写在类.域.构造函数.方法.定义之前.注释文档由两部分组成—

JAVA 文档注释,类的说明,HTML说明文档的生成

有的时候,我们会写一些类,编译成.class文件,给别人使用,那么,别人不知道这个类有哪些方法,如何调用. 所以我们需要做一个类的说明文档. 可以采用在.java类里面进行注释,通过注释来生成类的说明文档的方法. 一..java中注释的写法: Test1.java /* 文档注释 */ /** 此类是对数组进行取最值,排序等操作的 @author 张三 @version 1.0 */ public class Test1{ /** 取Int数组里面的最大值 @param arr 传入一个int数

如何为我们的程序编写开发文档——Java文档注释

Java文档注释是用于生成Java API文档的注释,通过在程序中的类.属性.方法部分加上注释,就可以用javadoc命令生成漂亮的API文档,是程序员进阶的必备技能. 注意,文档注释只说明紧跟其后的类.属性或者方法. Javadoc文档生成命令为: -author和-version可以省略. 根据在文档中显示的效果,文档注释分为三部分.举例如下: 第一部分是简述.如下图中被红框框选的部分: 简述部分写在一段文档注释的最前面,第一个点号 (.) 之前 (包括点号). 第二部分是详细说明部分.该部

Java - 34 Java 文档注释

Java 文档注释 Java只是三种注释方式.前两种分别是// 和/* */,第三种被称作说明注释,它以/** 开始,以 */结束. 说明注释允许你在程序中嵌入关于程序的信息.你可以使用javadoc工具软件来生成信息,并输出到HTML文件中. 说明注释,使你更加方便的记录你的程序的信息. javadoc 标签 javadoc工具软件识别以下标签: 标签 描述 示例 @author 标识一个类的作者 @author description @deprecated 指名一个过期的类或成员 @dep

java文档注释规范(一)

https://blog.csdn.net/huangsiqian/article/details/82725214 Javadoc工具将从四种不同类型的“源”文件生成输出文档:Java语言类的源文件(.java),包注释文件,概述注释文件和其他未处理的文件. 包注释文件(Package Comment File)每个包都有自己的文档注释.有两种方式来创建包注释文件: package-info.java - 可以包含包的声明,包注解(anotation),包注释和Javadoc 标签(tag).

Java文档注释

文档注释是用于生成API文档,API主要用于说明类.方法.成员变量 javadoc工具 处理文档源文件在类.接口.方法.成员变量.构造器和内部类之前的注释,忽略其他地方的文档注释.而且javadoc工具默认只处理以public或protected修饰的类.接口.方法.成员变量.构造器和内部类之前的文档注释. 如果开发者希望javadoc工具可以提取private修饰的内容,则可以使用javadoc工具是增加-private选项 javadoc命令的基本用法如下: javadoc 选项 Java源

Java 文档注释

Java只是三种注释方式.前两种分别是// 和/* */,第三种被称作说明注释,它以/** 开始,以 */结束. 说明注释允许你在程序中嵌入关于程序的信息.你可以使用javadoc工具软件来生成信息,并输出到HTML文件中. 说明注释,是你更加方面的记录你的程序的信息. javadoc 标签 javadoc工具软件识别以下标签: 标签 描述 示例 @author 标识一个类的作者 @author description @deprecated 指名一个过期的类或成员 @deprecated de

添加Java文档注释

一.在Eclipse中add javadoc comment的快捷键为: 快捷键为:ALT + SHIFT +J 二.Window-->Preferences-->General-->Keys;找到"add javadoc comment"更改自己喜欢的快捷键. 三.另外如果觉得注释也不爽时也可以改改,修改的方法有两种: 1.直接在eclipse给的模板下进行修改 打开eclipse Window-->Preferences-->Java-->Cod

静态的应用与文档注释

一.静态的应用一: 比如数组工具类: 每个应用程序中都有共性的功能,可以将这些功能进行抽取,独立封装以便复用 虽然可以通过建立ArrayTool的对象使用这些工具方法对数组进行操作 但是: 1.对象是用于封装数据的,可是ArrayTool对象并没封装特有数据(没有成员变量). 2.操作数组的每一个方法都没有用到ArrayTool对象中的特有数据 这时就考虑,让程序更严谨,是不需要对象的,可以将ArrayTool中的方法都定义成static的,直接用类名调用 将方法都静态后,可以方便于使用,但是该