Java doc简单说明
来源:互联网 发布:期货套利 知乎 编辑:程序博客网 时间:2024/05/16 23:42
javadoc 标记是插入文档注释中的特殊标记,它们用于标识代码中的特殊引用。javadoc 标记由“@”及其后所跟的标记类型和专用注释引用组成。三个部分——@、标记类型、专用注释引用。可以分成两部分:@ 和标记类型、专用注释引用。虽然 @ 和 标记类型之间有时可以用空格符分隔,但是最好始终将它们紧挨着写,以减少出错机会。
这些是注释类,属性和方法的。 简述是注释的第一个‘.’之前的所有内容。
javadoc通常从package、公开类或者接口、公开或者受保护的字段、公开或者受保护的方法提取信息。每条注释应该是以/**开始以*/结尾。例如
/** * * @param id the coreID of the person * @param userName the name of the person * you should use the constructor to create a person object */ public SecondClass(int id,String userName) { this.id = id; this.userName = userName; }
注释应该写在要说明部分的前面,如上所示。并且在其中可以包括html的标记,如果上面没有标记的话,那么you should usr the ……将会在javadoc里面紧跟@param userName….,这样不是我们希望的。一般注释可以分为类注释、方法注释、字段注释等。下面分别作简单的介绍
类注释
类注释应该在import语句的后面在类声明的前面,比如
package com.north.java; /** * @author ming * * this interface is to define a method print() * you should implements this interface is you want to print the username * @see com.north.ming.MainClass#main(String[]) */public interface DoSomething{ /** * @param name which will be printed * @return nothing will be returned * */ public void print(String name);}
其中@author 和@see都是常用的注释第一个表示作者,第二个表示参考的连接。
方法注释
方法注释要紧靠方法的前面,你可以在其中使用@param @return @throws等标签。例如
/** * * @param i * @return true if ..... else false * @throws IOException when reading the file ,if something wrong happened * then the method will throws a IOException */ public boolean doMethod(int i) throws IOException { return true; }
字段注释
只有public的字段才需要注释,通常是static德,例如
/** * the static filed hello */ public static int hello = 1;
总结:
还有一种就是:
TODO://Created on:
这类的注释我只了解到这一个。
0 0
- Java doc简单说明
- Java Doc说明-读Thinking in java
- android studio添加java doc的说明
- DOC操作目录说明
- Java Doc
- java doc
- Java Doc
- Java设计模式 (1) — 简单工厂.doc
- CMAS-文件服务器管理工具说明.doc
- MySql简单doc操作
- doc简单命令备注
- Java各种包简单说明
- java使用redis简单说明
- java使用redis简单说明
- JAVA JDK 简单下载说明
- Java注解的简单说明
- Java学习笔记——生成doc说明文档的方法
- Java 中文 doc?
- POJ 2349 Arctic Network(Prim,有好多要注意的)
- POJ 3259 Wormholes (Bellman-ford)
- 自动拉起
- IOS网络笔记--本地推送
- 程序员初学机器学习的四种方式
- Java doc简单说明
- 区间重合判断
- windows下通过services.msc命令把某些服务停止引起系统运行异常的事宜
- 如何禁用php eval
- 【Space Shoot Project】Creating hazards
- 乱
- Android studio设置启动时不自动打开上次关闭的项目
- SPOJ LCS2 Longest Common Substring II
- GT and sequence