Java学习之文档注释
来源:互联网 发布:java 培训 编辑:程序博客网 时间:2024/06/16 04:22
前言:关于注释这块,其实用的时候没怎么在意,看了《Java编程思想》这本书看到中间有很详细的讲解了,所以想写个文章记录下。
注释类型有2种:
(1):单行注释。以一个”//”起头,直到句末。
(2):多行注释。分两种:
- 以“/”开始,可以跨越多行,最后以“/”结束。
- 以“/*”开始,可以跨越多行,最后以“/”结束。和第二种相似。这种用于javadoc生成文档。
着重是多行注释的第二种:
作用:避免每次修改代码,都要特地修改文档,所以讲代码和文“档链”接起来。(用到一个工具提取注释:javadoc)
Javadoc
注意:
(1)所有的javadoc命令都只能在“/**”注释中出现.
(2)javadoc只能为public(公共)和protected(受保护)成员进行文档注释。
(3)有三种类型的注释文档,分别为:类、属性、方法。类注释位于类定义之前;属性注释位于属性定义之前;方法注释位于方法定义之前。如下列子
/** 类注释 */public class Demo{/** 属性注释 */public int i;/** 方法注释 */public void f(){}}
使用javadoc方式主要有两种
(1)嵌入式HTML
javadoc通过生成的HTML文档传送HTML命令,使你能充分利用HTML。主要目的是为了对代码进行格式化。
/***<pre>*System.out.println(new Date());*</pre>**/
注意:文档注释中,位于每一行开头的星号和前导空格会被javadoc丢弃。不要在嵌入式HTML中使用标题标签,如<.h1>或<.hr>,因为javadoc会插入自己的标题,这样会和你的标签冲突。所有类型的类、属性、方法注释文档都支持嵌入式HTML。
(2)文档标签
- @see:引用其他类的文档
- @version:版本
- @author:作者信息
- @param:方法参数(该标签用于方法文档中)
- @return:方法返回值(用于方法文档)
阅读全文
0 0
- Java学习之文档注释
- Java学习个人备忘录之文档注释
- JAVA学习笔记 - javadoc注释文档
- Java注释和嵌入式文档----学习笔记
- 知识学习——Java文档注释
- Java之利用javadoc生成注释文档
- java学习09-通过文档注释->生成开发文档
- Java 从基础到进阶学习之路---类编写以及文档注释.
- Java注释及文档注释
- JAVA 文档注释--JAVADOC文档
- Java 文档&注释 -Java学习笔记(32)
- 【Java重新学习】Java面向对象-Javadoc文档注释
- JAVA 文档注释
- java文档注释
- java文档注释
- Java文档注释说明
- java注释文档
- Java文档注释方法
- Linux命令-02
- 聊聊分布式事务
- NetBIOS初步了解
- junit 4 怎么 添加到eclipse
- mysql中字符集 utf8 和utf8mb4 有什么区别?
- Java学习之文档注释
- 在 SSM 中基于 MyBatis-PageHelper 分页插件的分页功能实现
- 刷题——5.8
- 练习:打印九九乘法表
- 【noip2014】寻找道路
- JN项目-序号问题
- 时间复杂度
- dtb文件编译
- 安卓实现录音机的录音功能