Javadoc注释的用法
Javadoc注释的用法
相关阅读:http://blog.163.com/hui_san/blog/static/5710286720104191100389/
- Java 文档
// 注释一行
/* ...... */ 注释若干行
/** ...... */ 注释若干行,并写入 javadoc 文档通常这种注释的多行写法如下:
/**
* .........
* .........
*/javadoc -d 文档存放目录 -author -version 源文件名.java
这条命令编译一个名为"源文件名.java"的 java 源文件,并将生成的文档存放在"文档存放目录"指定的目录下,生成的文档中 index.html 就是文档的首页。-author 和 -version 两个选项可以省略。二. 文档注释的格式
1. 文档和文档注释的格式化
生成的文档是 HTML 格式,而这些 HTML 格式的标识符并不是 javadoc 加的,而是我们在写注释的时候写上去的。
比如,需要换行时,不是敲入一个回车符,而是写入 <br>,如果要分段,就应该在段前写入 <p>。
文档注释的正文并不是直接复制到输出文件 (文档的 HTML 文件),而是读取每一行后,删掉前导的 * 号及 * 号以前的空格,再输入到文档的。如/**
* This is first line. <br>
***** This is second line. <br>
This is third line.
*/2. 文档注释的三部分
先举例如下/**
* show 方法的简述.
* <p>show 方法的详细说明第一行<br>
* show 方法的详细说明第二行
* @param b true 表示显示,false 表示隐藏
* @return 没有返回值
*/
public void show(boolean b) {
frame.show(b);
}第一部分是简述。文档中,对于属性和方法都是先有一个列表,然后才在后面一个一个的详细的说明
简述部分写在一段文档注释的最前面,第一个点号 (.) 之前 (包括点号)。换句话说,就是用第一个点号分隔文档注释,之前是简述,之后是第二部分和第三部分。第二部分是详细说明部分。该部分对属性或者方法进行详细的说明,在格式上没有什么特殊的要求,可以包含若干个点号。
* show 方法的简述.
* <p>show 方法的详细说明第一行<br>
* show 方法的详细说明第二行简述也在其中。这一点要记住了
第三部分是特殊说明部分。这部分包括版本说明、参数说明、返回值说明等。
* @param b true 表示显示,false 表示隐藏
* @return 没有返回值三. 使用 javadoc 标记
javadoc 标记由"@"及其后所跟的标记类型和专用注释引用组成
javadoc 标记有如下一些:
@author 标明开发该类模块的作者
@version 标明该类模块的版本
@see 参考转向,也就是相关主题
@param 对方法中某参数的说明
@return 对方法返回值的说明
@exception 对方法可能抛出的异常进行说明@author 作者名
@version 版本号
其中,@author 可以多次使用,以指明多个作者,生成的文档中每个作者之间使用逗号 (,) 隔开。@version 也可以使用多次,只有第一次有效使用 @param、@return 和 @exception 说明方法
这三个标记都是只用于方法的。@param 描述方法的参数,@return 描述方法的返回值,@exception 描述方法可能抛出的异常。它们的句法如下:
@param 参数名参数说明
@return 返回值说明
@exception 异常类名说明四. javadoc 命令
用法:
javadoc [options] [packagenames] [sourcefiles]选项:
-public 仅显示 public 类和成员
-protected 显示 protected/public 类和成员 (缺省)
-package 显示 package/protected/public 类和成员
-private 显示所有类和成员
-d <directory> 输出文件的目标目录
-version 包含 @version 段
-author 包含 @author 段
-splitindex 将索引分为每个字母对应一个文件
-windowtitle <text> 文档的浏览器窗口标题javadoc 编译文档时可以给定包列表,也可以给出源程序文件列表。例如在 CLASSPATH 下有两个包若干类如下:
fancy.Editor
fancy.Test
fancy.editor.ECommand
fancy.editor.EDocument
fancy.editor.EView可以直接编译类:
javadoc fancy\Test.java fancy\Editor.java fancy\editor\ECommand.java fancy\editor\EDocument.java fancy\editor\EView.java也可以是给出包名作为编译参数,如:javadoc fancy fancy.editor
可以自己看看这两种方法的区别到此为止javadoc就简单介绍完了,想要用好她还是要多用,多参考标准java代码(可参考JDK安装目录下的src源文件包)
Javadoc注释的用法相关推荐
- 【Java学习笔记之十八】Javadoc注释的用法
Javadoc注释的用法 Java 文档 // 注释一行 /* ...... */ 注释若干行 /** ...... */ 注释若干行,并写入 javadoc 文档 通常这种注释的多行写法如下: /* ...
- JavaDoc注释的使用
JavaDoc注释的使用 2009-06-16 11:29 woaidongmao cpp博客 我要评论(0) 字号:T | T Javadoc是Sun公司提供的一个技术,它从程序源代码中抽取类.方法 ...
- 详细聊聊Javadoc注释规范
Javadoc 注释规范 1. 注释分类 2. Java文档和Javadoc 3. 文档注释的格式 3.1 文档和文档注释的格式化 3.2 文档注释的三部分 4. 使用Javadoc标记 4.1 ...
- java中解释命令_闲来无事可来了解下Java中Javadoc命令的用法
[javadoc命令的用法] 1.java源文件里,注释以/**开始 并以*/结束,里面可以包含普通文件,HTML标记和javaDoc标记.这些将构成javaDoc文档. 2.javadoc命令只能处 ...
- VTK:彩色注释立方体用法实战
VTK:彩色注释立方体用法实战 程序输出 程序完整源代码 程序输出 程序完整源代码 #include <vtkAnnotatedCubeActor.h> #include <vtkA ...
- 如何在 IntelliJ IDEA 中快速生成 JavaDoc 注释模板
如何在 IntelliJ IDEA 中快速生成 JavaDoc 注释模板 此博客存在上一个版本,如果读者对笔者以前版本的博客依然感兴趣,可以访问此链接:https://blog.csdn.net/wa ...
- 接口方法javadoc注释_继承Javadoc方法注释
接口方法javadoc注释 尽管用于javadoc工具的JDK工具和实用程序页面通过实现和继承方法来描述Javadoc方法注释重用的规则,但是当实际上不需要使用{@inheritDoc}时,很容易不必 ...
- java关键词 英文原文解释,javadoc注释规范(国外英文资料).doc
javadoc注释规范(国外英文资料) javadoc注释规范(国外英文资料) Does Javadoc make notes? I. Java documents? Notes a / /? Som ...
- Python变量与注释高级用法
Python变量与注释高级用法 1.概述 好的变量和注释并非为计算机而写,而是为每个阅读代码的人而写.变量与注释是表达作者思想的基础,他们对代码质量的贡献母庸质疑. 2.变量 2.1.变量解包 1.什 ...
- 怎么解决缺少java.doc_阿里代码规范检测中方法缺少javadoc注释怎么办
阿里代码规范检测中方法缺少javadoc注释怎么办 发布时间:2020-08-12 15:01:48 来源:亿速云 阅读:204 作者:小新 这篇文章给大家分享的是有关阿里代码规范检测中方法缺少jav ...
最新文章
- 仅需6步,教你轻易撕掉app开发框架的神秘面纱(6):各种公共方法及工具类的封装
- numpy使用diagonal函数和sum函数计算矩阵的迹(trace)、使用T函数对矩阵进行转置(transpose matrix)
- 地理空间数据库(Geodatabase)结构(翻译)
- C4C销售订单中业务伙伴的自动决定功能Partner determination procedure
- ES6学习笔记(一):轻松搞懂面向对象编程、类和对象
- 统计信号处理基础——估计与检测理论 Kay
- 简单几步教会你画出透明丝袜,初学者画出透明质感
- android studio主moudle无法调用依赖moudle里的jar包
- rss下载_Microsoft下载中心RSS提要
- win10 家庭中文版打开本地组策略编辑器
- 谈学习中的改变——有病要诊断,有药要服用
- 帝国CMS数据字典 Ctrl+F查询
- 中国风味苹果酒市场现状研究分析与发展前景预测报告(2022)
- 网络并发知识第一天网络通信基本原理
- OpenCV技巧 | 二值图孔洞填充方法与实现(附Python/C++源码)
- TCL脚本语言详解(1)
- 正交实验正交表的创建
- rviz-Ros Wiki官网教程学习笔记(1)-用户指南
- 2018虎牙服务器维护,关于虎牙公会系统迁移维护的通知
- c语言uart串口通讯,UART串口通信的基本应用
热门文章
- 记一次 JAVA 的内存泄露分析 1
- 我是如何在5 天内,完成 60 个类的核心模块的重构
- Kotlin 新版来了,支持跨平台!
- H.264标准(一)MP4封装格式详解
- 获取oracle日志文件,ORACLE关于日志文件基本操作
- HTML判断JSON长度,javascript如何判断是否为json?
- python流星雨代码_用python一起来看流星雨
- 帆软函数TOIMAGE应用
- qt中socket通信流程图_Qt学习 之 Socket通信
- nv21转jpg c语言,Yuv420转Jpeg(C语言实现)