javadoc注释规范
javadoc做注释
一. 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. 文档注释的三部分
先举例如下
/**
JAVADOC 的注释规范对于 Java 注释共有三种: 1. 2. 3. // 注释一行 /* ... */ 注释若干行 /** ... */ 注释若干行,并写入 javadoc 文档 通常这种...
java注释书写规范_IT/计算机_专业资料。Java 注释书写规范 Javadoc 是 Sun 公司提供的一个技术,它从程序源代码中抽取类、方法、成 员等注释形成一个和源代码...
Java注释规范整理_计算机软件及应用_IT/计算机_专业资料。Java 注释规范整理在...javadoc 注释标签语法 @author 对类的说明 标明开发该类模块的作者 @version ...
Java注释规范_电子/电路_工程科技_专业资料。Java的各种注释,以及写入Javadoc的注释要求对于Java 注释我们主要了解两种: // 注释一行 /* ... */ 注释若干行...
Java注释规范_计算机软件及应用_IT/计算机_专业资料。Java注释规范,很详细,很...*/ 文档注释: 注释若干行, 并写入 javadoc 文档。 每个文档注释都会被置于...
javadoc 就简单介绍完了,想要用好她还是要多用,多参考标准 java 代码 Java 代码规范 --注释 @author LEI @version 1.10 2005-09-01 1 注释文档的格式 fancy...
Java注释规范_IT/计算机_专业资料。Java 注释规范 定义这个规范的目的是让项目...*/ 注释若干行,并写入 javadoc 文档 1. 注释要简单明了。 String userName ...
实现注释:/*…*/和//,用以注释代码或或者实现细节。 文档注释:/**…*/,可以通过 javadoc 工具转换成 HTML 文件,描述代码的规范,可以被那些手头没有源 码的...
javadoc注释_其它考试_资格考试/认证_教育专区。今日推荐 四季养生 中医养生与... javadoc注释规范 9页 1下载券 JavaDOC注释使用方法 14页 免费 介绍javadoc...
java中的注释规范_IT/计算机_专业资料。java中的注释规范JAVA 注释方法及格式 ...*/ 注释若干行,并写入 javadoc 文档。每个文档注释都会被置于注释定界符 /**....
热门文档