首页 > 编程语言 >Java的包机制和JavaDoc生成帮助文档

Java的包机制和JavaDoc生成帮助文档

时间:2024-08-24 23:04:05浏览次数:6  
标签:文件 Java JavaDoc 文件夹 文档 java com

Java项目中通常采用分层的结构来组织代码和资源,以下是这种结构的典型层次:
项目文件夹:这是整个Java项目的根目录。通常包括一些配置文件(如pom.xmlbuild.gradle),用于构建和管理项目依赖。
模块文件夹:在大型项目中,通常会将项目划分为多个模块(子项目),每个模块有自己的代码、资源和依赖。每个模块可以独立构建,并且可以有自己的pom.xml(Maven项目)或build.gradle(Gradle项目)。模块文件夹通常位于项目文件夹的根目录下。
包(Package):在模块文件夹下的src/main/java路径中,代码文件会按照包名进行组织。包是用于逻辑组织类的命名空间。包名通常对应文件系统中的文件夹结构。例如,包名为com.example.module,则文件结构可能为src/main/java/com/example/module

类文件:类文件(以.java结尾的文件)存储在包文件夹中,每个类文件对应一个Java类。类文件包含类的定义、方法、属性等。在包内的类文件第一句代码(自动生成)都是

​ package package1.package2

此处package1是package2的父包文件

包机制

包的本质是文件夹

  • 一般利用公司域名倒置作为包名
  • www.baidu.com 文件夹路径依次是 com/baidu/www

导入包 import

有pack语句,其必须在第一行

import 语句必须在pack语句下

import package1[.package2...].(classname|*);

import com.* //导入com包下所有内容

JavaDoc

javadoc命令用来生成自己的API文档(网页上),需要使用文档注释(Java语法-注释 如何创建与配置空项目

参数信息

@author 作者名
@version 版本号
@since 指明需要最早使用的jdk版本
@param 参数名
@return 返回值情况
@throws 异常抛出情况

在要创建帮助文档的文件所在的文件夹下打开命令行

输入命令

javadoc -encoding UTF-8 -charset UTF-8 带生成文件.java

中的

 -encoding UTF-8 -charset UTF-8

参数是为了正常显示中文

必要命令

javadoc 文件名.java

打开对应文件夹中的.html文件即可打开自动生成的帮助文档网页

标签:文件,Java,JavaDoc,文件夹,文档,java,com
From: https://www.cnblogs.com/LiuYP-blog/p/18378448

相关文章