Java注释写好了,如何提取出来生产说明文档呢?
2010-11-04 20:03
399 查看
public static final int ANOTHER_FOO_TYPE = 1;
/**
* The current foo type
*/
private int type;
/**
* Constructs a Bar
*/
public Bar() {
type = FOO_TYPE;
}
/**
* Returns current foo type
*
* @return current foo type
* @deprecated As of version 2.3, use {@link #getFoo() getFoo()}instead
*/
public int foo() {
return getFoo();
}
/**
* Returns current foo type
*
* @return current foo type
* @since V2.3
*/
public int getFoo() {
return getFoo();
}
/**
* Changes current foo type
*
* @param type
* new type of foo
* @throws IllegalArgumentException
* When type invalid
*/
public void setFoo(int newValue) {
if ((newValue != FOO_TYPE) && (newValue != ANOTHER_FOO_TYPE)) {
throw new IllegalArgumentException("Bad type");
}
type = newValue;
}
/**
* Placeholder method for see tags
*
* @see Bar#FOO_TYPE
* @see Bar#getFoo()
* @see #getFoo()
* @see "My Book"
* @see <a href="http://www.jguru.com">jGuru </a>
*/
public void myVoid() {
}
}
1. 将java文件(名字JavadocDemo.java)放置在某一目录,如:"D:/doc";
2. 运行cmd,进入该目录,执行“javadoc JavadocDemo.java”即可生成HTML格式的说明文档。
3. JavaDoc工具的使用格式如下:
javadoc [选项][软件包名称][源文件][@file]
上述格式中的@file指的是包含文件,为了简化JavaDoc命令,可以将需要生成文档的软件包名和源文件名放到一个文本文件中。例如,为了简化以下命令:
javadoc -d mydoc test.Student test.Teacher
可以建立一个名称为myfile.txt的文件,内容如下:
mydoc text.Student
text.Teacher
然后执行命令
javadoc -d mydoc @myfile.txt
/**
* The current foo type
*/
private int type;
/**
* Constructs a Bar
*/
public Bar() {
type = FOO_TYPE;
}
/**
* Returns current foo type
*
* @return current foo type
* @deprecated As of version 2.3, use {@link #getFoo() getFoo()}instead
*/
public int foo() {
return getFoo();
}
/**
* Returns current foo type
*
* @return current foo type
* @since V2.3
*/
public int getFoo() {
return getFoo();
}
/**
* Changes current foo type
*
* @param type
* new type of foo
* @throws IllegalArgumentException
* When type invalid
*/
public void setFoo(int newValue) {
if ((newValue != FOO_TYPE) && (newValue != ANOTHER_FOO_TYPE)) {
throw new IllegalArgumentException("Bad type");
}
type = newValue;
}
/**
* Placeholder method for see tags
*
* @see Bar#FOO_TYPE
* @see Bar#getFoo()
* @see #getFoo()
* @see "My Book"
* @see <a href="http://www.jguru.com">jGuru </a>
*/
public void myVoid() {
}
}
1. 将java文件(名字JavadocDemo.java)放置在某一目录,如:"D:/doc";
2. 运行cmd,进入该目录,执行“javadoc JavadocDemo.java”即可生成HTML格式的说明文档。
3. JavaDoc工具的使用格式如下:
javadoc [选项][软件包名称][源文件][@file]
上述格式中的@file指的是包含文件,为了简化JavaDoc命令,可以将需要生成文档的软件包名和源文件名放到一个文本文件中。例如,为了简化以下命令:
javadoc -d mydoc test.Student test.Teacher
可以建立一个名称为myfile.txt的文件,内容如下:
mydoc text.Student
text.Teacher
然后执行命令
javadoc -d mydoc @myfile.txt
相关文章推荐
- 如何将java程序中的文档注释提取出来生成说明文档
- 第1章 Java基本概念及环境配置——FAQ1.16 如何将程序中的文档注释提取出来生成说明文档?
- Eclipse中如何修改Java代码注释的样式和如何提取出注释文档
- .net 下如何将文档文件(Word, Pdf等) 中的文本提取出来
- [摘选]如何使用注释文档和提取?
- .net 下如何将文档文件(Word, Pdf等) 中的文本提取出来
- 磨刀不误砍材工 - Java的基础语言要素(注释-生成你自己的API说明文档)
- {@link}与@see的简单使用以及区别--如何写好Java代码注释。
- 黑马程序员:给class文件写说明书,java的说明说通过文档注释来完成
- 用javadoc提取此注释文档,并产生一个HTML文件,最后通过浏览器查看结果 直接Tools>Generate javadoc
- 如何写Java文档注释(Java Doc Comments)
- JAVA 文档注释,类的说明,HTML说明文档的生成
- 如何写Java文档注释(Java Doc Comments)
- 如何为我们的程序编写开发文档——Java文档注释
- 如何写Java文档注释(Java Doc Comments)
- .net 下如何将文档文件(Word, Pdf等) 中的文本提取出来(转)
- Doxygen代码注释规定和生产文档说明
- 如何快速的将word文档中的图片提取出来
- 如何写好java代码注释
- 转载:C#如何实现把word文档内的图片提取出来