Day13-20251207

小技巧

Ctrl+左键可以跳转到一些地方，比如String

包机制

• 为了更好的组织类。java提供了包机制，用于区别类名的命名空间。
• 包语句的语法格式为：

package pkg1[. pck2[. pkg3...]];

• 一般利用公司域名倒置作为包名：
• 为了能够使用某一个包的成员，我们需要在java程序中明确导入该包。使用"import"语句可完成此功能

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

package必须在最上面

import在下面

import com.jiagunagqing.base.* .*代表通配符，表示导入这个包下所有的类

包的本质就是一个文件夹

如何新建三层文件夹：设置

JavaDoc

javadoc命令是用来生成自己API文档的

搜索javase帮助文档、找到Java SE 文档—API 和文档|Oracle 中国、进去后找到核心API文档、选择8，英文（jdk用的1.8，只有英文版）。

Java在线API帮助文档网址：https://docs.oracle.com/javase/8/docs/api/

参数信息：

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

加在类上面就是类的注释

加在方法上面就是方法的注释

命令提示符操作：

cmdD:\ruanjian\xuexiruanjian\Typora\Java\idea\idea\JavaSE\JavaSE\HelloWorld\src\com\jiaguangqing\base>

javadoc -encoding UTF-8 -charset UTF-8 Doc.java

Java命令-中间参数为了让中文显示更加正常-把java文件编译成文档便于大家阅读

执行

正在加载源文件Doc.java...
正在构造 Javadoc 信息...
标准 Doclet 版本 1.8.0_471
正在构建所有程序包和类的树...
正在生成.\com\jiaguangqing\base\Doc.html...
Doc.java:14: 警告: @param 没有说明

• @param name
  ^
  Doc.java:15: 警告: @return 没有说明
  • @return
    ^
    Doc.java:16: 警告: @throws 没有说明
    • @throws Exception
      ^
      正在生成.\com\jiaguangqing\base\package-frame.html...
      正在生成.\com\jiaguangqing\base\package-summary.html...
      正在生成.\com\jiaguangqing\base\package-tree.html...
      正在生成.\constant-values.html...
      正在构建所有程序包和类的索引...
      正在生成.\overview-tree.html...
      正在生成.\index-all.html...
      正在生成.\deprecated-list.html...
      正在构建所有类的索引...
      正在生成.\allclasses-frame.html...
      正在生成.\allclasses-noframe.html...
      正在生成.\index.html...
      正在生成.\help-doc.html...
      3 个警告

为了让文章更优秀不出现乱码，因为中文有些地方不识别

package com.jiaguangqing.base;/*** @author Jiaguangqing* @version 1.0* @since 1.8*/
public class Doc {String name;//他是一个属性/*** @author Jiaguangqing* @param name* @return* @throws Exception*/public String test (String name) throws Exception{return name;//他是一个方法}//我是通过命令行生成的  javadoc 参数 Java文件//作业：学会查找使用IDEA生成JavaDOC文档！   面向百度编程//基础部分的一切知识，后面几乎每天都会用
}

本文介绍了Java编程中的包机制和JavaDoc文档生成方法。包机制通过域名倒置命名规范组织类文件，使用package和import语句管理命名空间。JavaDoc用于生成API文档，支持@author、@version等参数标注，可通过命令行工具生成HTML格式文档。文章还演示了如何为类和添加注释，并提示使用IDEA集成开发环境生成文档。这些基础知识点是Java开发中的常用技能。