Java学习日记-Day2

本文介绍了Java编程中的文档注释及其重要性,包括标签使用、生成Javadoc文档的方法。同时详细讲解了Dos命令在文件操作、目录管理等方面的应用,以及Java类的组织结构、API查找技巧和标识符命名规范。
摘要由CSDN通过智能技术生成

文档注释

文档注释是Java编程中的一种特殊注释类型,用于为类、方法、字段和其他程序元素提供详细的文档和说明。它们通常位于程序元素的前面,并使用特定的标记格式。文档注释不仅为开发者提供了关于程序元素的信息,还可以用于生成文档。

文档注释以/**开头,以*/结尾,可以包含多行注释。文档注释中的内容通常包括以下要素:

  1. 描述性文本:提供了有关程序元素的详细描述,包括其用途、功能和用法。

  2. 标签:标签以@符号开头,用于标识特定注释元素。常见的标签包括:

    • @param:用于描述方法参数的含义和用法。
    • @return:用于描述方法返回值的含义。
    • @throws@exception:用于描述方法可能引发的异常情况。
    • @see:用于引用其他相关文档或资源。
    • @since:用于指定程序元素的起始版本。
    • @deprecated:用于标记过时的程序元素。

以下是一个Java文档注释的示例:

/**
 * @author 鱼儿
 * @version 1.0
 */


public class Hello{

	
	public static void main(String[] args){
		System.out.println("hello,world~");
	}
}

在这个示例中,我们可以看到:

  • @author@version是标签,可以提供一些相关信息。
  • 注释以/** ... */包围。

生成文档

在cmd中用javadoc -d 文件夹名 -xx -yy Hello.java命令可以生成文档。其中-xx -yy是标签。-d 文件夹名中输入目标文件夹地址。
在这里插入图片描述
生成完成后,获得的文档:
在这里插入图片描述
打开index.html,如下图所示,可以看到版本和作者信息。
在这里插入图片描述

Dos命令

当使用DOS命令时,通常需要在命令提示符窗口中输入命令并按下回车键。以下是一些常用命令:

  1. dir 显示当前目录下的文件和子目录。

    dir
    
  2. cd 切换目录,例如进入Documents目录:

    cd Documents
    
  • 切换到指定目录: cd directory_name:切换到指定目录。例如,要切换到名为Documents的目录,只需输入cd Documents

  • 切换到上级目录:
    cd ..:切换到当前目录的上一级目录。这对于向上导航非常有用。

  • 切换到根目录: cd \:切换到根目录,也称为系统根目录。这是文件系统的最顶层目录。

  • 切换到用户主目录:
    cd %userprofile%:切换到当前用户的主目录。这是用户的个人文件夹,通常包含文档、下载、音乐等子目录。

  • 使用绝对路径切换目录: cd C:\path\to\directory:使用绝对路径切换到指定目录。例如,cd C:\Users\Username\Documents将直接切换到指定路径。

  • 使用相对路径切换目录:
    可以使用相对路径切换到目录,相对路径是相对于当前目录的路径。例如,在C:\Users\Username目录下,cd Desktop将切换到C:\Users\Username\Desktop

  • 切换到其他驱动器: 如果你有多个硬盘驱动器,可以使用驱动器字母来切换到其他驱动器。例如,D:将切换到D驱动器的根目录。

  • 使用通配符: 你可以使用通配符(例如*?)来匹配多个目录名称。例如,cd D:\Backup\2023\*将切换到2023年备份文件夹中的任何子目录。

  1. copy 复制文件,语法为copy source destination,例如复制文件file1.txt到目录Folder:

    copy file1.txt Folder
    
  2. del 删除文件,例如删除文件filename.txt:

    del filename.txt
    
  3. ren 重命名文件,使用ren oldname newname,例如将文件oldfile.txt重命名为newfile.txt:

    ren oldfile.txt newfile.txt
    
  4. type 查看文本文件的内容,如查看filename.txt的内容:

    type filename.txt
    
  5. mdmkdir 创建新目录,比如创建名为NewFolder的新目录:

    mkdir NewFolder
    
  6. rdrmdir 删除目录,语法为rmdir FolderName,例如删除名为OldFolder的目录:

    rmdir OldFolder
    
  7. cls 清屏,清除控制台上的内容。

    cls
    
  8. exit 退出命令提示符窗口。

    exit
    

Java文档

Java API是Java编程语言的应用程序接口,它是一组可以用来编写Java程序的规则和工具的集合。想象它就像一本巨大的字典,里面有很多单词和它们的定义,只不过这本字典是为程序员设计的。

这些API包括了各种各样的命令和功能,它们可以让程序员轻松地完成各种任务,比如创建图形界面、处理文件、连接互联网等等。所以,当程序员需要完成某项任务时,他们可以查阅Java API,就像查字典一样,找到相应的命令和方法,然后使用它们来编写自己的程序。

总之,Java API就是程序员在编写Java程序时可以使用的一组工具和规则,它们让编写代码变得更加容易和高效。

为了更好地使用Java文档,先了解一下Java类的组织形式。

Java类的组织形式
在这里插入图片描述
(来自韩顺平老师的网课)

在线API手册:https://www.matools.com/api

查找方法:

  • 按照 包->类->方法 的顺序查找
  • 直接索引

一些查漏补缺

  1. && 和 & 使用区别
    && 短路与:如果第一个条件为 false,则第二个条件不会判断,最终结果为 false,效率高
    & 逻辑与:不管第一个条件是否为 false,第二个条件都要判断,效率低
    开发中, 我们使用的基本是使用短路与&&, 效率高。

  2. || 和 | 使用区别
    || 短路或:如果第一个条件为 true,则第二个条件不会判断,最终结果为 true,效率高
    | 逻辑或:不管第一个条件是否为 true,第二个条件都要判断,效率低
    开发中,我们基本使用 || 。

  3. 标识符命名规范

    • 包名:多单词组成时所有字母都小写:aaa.bbb.ccc //比如 com.hsp.crm
    • 类名、接口名:多单词组成时,所有单词的首字母大写:XxxYyyZzz [大驼峰]
      比如: TankShotGame
    • 变量名、方法名:多单词组成时,第一个单词首字母小写,第二个单词开始每个单词首字母大写:xxxYyyZzz [小驼峰, 简称 驼峰法]
      比如: tankShotGame
    • 常量名:所有字母都大写。多单词时每个单词用下划线连接:XXX_YYY_ZZZ
      比如 :定义一个所得税率 TAX_RATE
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值