Unprocessed Files
Your source files can include any files that you want the
javadoc
tool to copy to the
destination directory. These files usually include graphic files, example Java source
and class files, and self standing HTML files with a lot of content that would
overwhelm the documentation comment of a typical Java source file.
To include unprocessed files, put them in a directory called doc-files. The doc-
files directory can be a subdirectory of any package directory that contains source
files. You can have one
doc-files
subdirectory for each package.
Oracle Solaris, Linux, and macOS: For example, if you want to include the image of
a button in the
java.awt.Button
class documentation, then place the image file in the
/
home/user/src/java/awt/doc-files/
directory. Don't place the
doc-files
directory at
/
home/user/src/java/doc-files
, because
java
isn't a package. It doesn't contain any
source files.
Windows: For example, if you want to include the image of a button in the
java.awt.Button
class documentation, then place the image file in the
\src\java\awt
\doc-files
directory. Don't place the doc-files directory at
\src\java\doc-files
,
because
java
is not a package. It doesn't contain any source files.
All links to the unprocessed files must be included in the code because the
javadoc
tool doesn't look at the files. The
javadoc
tool copies the directory and all of its
contents to the destination. The following example shows how the link in the
Button.java
documentation comment might look:
/**
* <p> This button looks like this:</p>
* <img src="doc-files/Button.gif"/>
*/
Test and Template Files
You can store test and template files in the source tree in the same directory with or in
a subdirectory of the directory where the source files reside. To prevent test and
template files from being processed, run the
javadoc
tool and explicitly pass in
individual source file names.
Test files are valid, compilable source files. Template files aren’t valid, compatible
source files, but they often have the
.java
suffix.
• Test Files : If you want your test files to belong to either an unnamed package or
to a package other than the package that the source files are in, then put the test
files in a subdirectory underneath the source files and give the directory an invalid
name. If you put the test files in the same directory with the source files and call
the
javadoc
tool with a command-line argument that indicates its package name,
then the test files cause warnings or errors. If the files are in a subdirectory with
an invalid name, then the test file directory is skipped and no errors or warnings
are issued. For example, to add test files for source files in com.package1, put
them in a subdirectory in an invalid package name. The following directory name
is invalid because it contains a hyphen:
– Oracle Solaris, Linux, and macOS:
com/package1/test-files/
– Windows:
com\package1\test-files\
If your test files contain documentation comments, then you can set up a separate
run of the
javadoc
tool to produce test file documentation by passing in their test
source file names with wild cards, such as
com/package1/test-files/*.java
.
Chapter 2
2-2
剩余42页未读，继续阅读
weixin_40191861_zj
- 粉丝: 79
- 资源: 1万+
我的内容管理
展开
最新资源
- C++标准程序库：权威指南
- Java解惑：奇数判断误区与改进方法
- C++编程必读：20种设计模式详解与实战
- LM3S8962微控制器数据手册
- 51单片机C语言实战教程：从入门到精通
- Spring3.0权威指南：JavaEE6实战
- Win32多线程程序设计详解
- Lucene2.9.1开发全攻略：从环境配置到索引创建
- 内存虚拟硬盘技术：提升电脑速度的秘密武器
- Java操作数据库：保存与显示图片到数据库及页面
- ISO14001：2004环境管理体系要求详解
- ShopExV4.8二次开发详解
- 企业形象与产品推广一站式网站建设技术方案揭秘
- Shopex二次开发：触发器与控制器重定向技术详解
- FPGA开发实战指南：创新设计与进阶技巧
- ShopExV4.8二次开发入门：解决升级问题与功能扩展
资源上传下载、课程学习等过程中有任何疑问或建议，欢迎提出宝贵意见哦~我们会及时处理！
点击此处反馈
