零基础学Java|第三篇:DOS 命令、转义字符、注释与代码规范

0 阅读6分钟

Java 基础篇(二):DOS 命令、转义字符、注释与代码规范

你好,欢迎回到 Java 零基础学习系列!
在上一篇中,我们成功搭建了 Java 开发环境,并运行了第一个程序。

今天我们来学习一些写代码前必须掌握的基础知识:常用的 DOS 命令(方便操作文件)、转义字符(在字符串中表达特殊符号)、注释(给代码加说明)以及代码规范(写出干净易读的代码)。这些知识会让你今后的编码更加顺畅和专业。


1. DOS 命令:与计算机对话的基础

在 Java 开发中,我们经常需要编译和运行程序(使用 javacjava),这些操作都是在命令行(Windows 下叫 命令提示符,也叫 DOS 窗口)中进行的。因此,掌握几个常用的 DOS 命令会让操作更高效。

1.1 如何打开命令行

  • Windows 10/11:按下 Win + R 键,输入 cmd,回车。
  • 或者在开始菜单搜索“命令提示符”打开。

1.2 常用命令

命令英文含义作用示例
cdChange Directory切换当前目录cd D:\JavaCode 进入 D 盘的 JavaCode 文件夹
cd .. 返回上一级目录
cd \ 返回当前盘符根目录
dirDirectory列出当前目录下的文件和文件夹dir
mdMake Directory创建文件夹md myproject 创建名为 myproject 的文件夹
rdRemove Directory删除空文件夹rd myproject
delDelete删除文件del HelloWorld.class 删除 class 文件
clsClear Screen清屏cls
exitExit退出命令行exit

提示:在命令行中,输入命令后按回车执行。可以按上下箭头快速调出之前输入的命令。

示例场景:在 D 盘创建一个工作区,并编译运行 Java 程序
d:                 // 切换到 D 盘
md JavaWork        // 创建文件夹 JavaWork
cd JavaWork        // 进入文件夹
notepad Hello.java // 用记事本创建 Hello.java(如果没安装其他编辑器)
// 编写代码后保存,回到命令行
javac Hello.java   // 编译
java Hello         // 运行

2. 转义字符:在字符串中表达特殊含义

在 Java 中,字符串是用双引号括起来的,比如 "Hello"。但如果想在字符串中输出一个双引号本身,或者换行、制表符等,就需要使用转义字符——以反斜杠 \ 开头,后跟一个或多个字符,组合成特殊含义。

2.1 常用转义字符

转义字符含义示例输出
\n换行"第一行\n第二行" → 第一行
第二行
\r回车"第一行\r第二行" → 第二行(将光标移到行首,覆盖输出)
\t制表符(Tab)"姓名:\t张三" → 姓名: 张三
\\反斜杠本身"C:\\Program Files" → C:\Program Files
\"双引号"他说:\"你好\"" → 他说:"你好"
\'单引号(在字符中使用)'\'' 表示单引号字符

2.2 示例程序:演示转义字符

public class EscapeDemo {
    public static void main(String[] args) {
        System.out.println("第一行\n第二行");   // 换行
        System.out.println("Java\t编程");      // 制表符
        System.out.println("路径:C:\\Program Files"); // 反斜杠
        System.out.println("他说:\"Java很有趣\"");     // 双引号
        System.out.println("回车测试:先输出一段\r然后覆盖"); // 回车效果
    }
}

运行结果:

第一行
第二行
Java	编程
路径:C:\Program Files
他说:"Java很有趣"
然后覆盖

转义字符运行结果截图

注意最后一行输出的是“然后覆盖”,因为 \r 将光标移到行首,后面的文字覆盖了前面的“回车测试”。


3. 注释:给代码添加说明

注释是写给程序员看的,不会被编译器执行。好的注释能让代码更容易理解和维护。Java 支持三种注释:

3.1 单行注释

// 开头,直到行末。一般用于简短说明。

// 这是单行注释
int age = 18; // 定义年龄变量

3.2 多行注释

/* 开头,*/ 结尾,中间可以跨多行。一般用于较长的描述或临时注释掉代码块。

/*
  这是一个多行注释
  可以写多行内容
  这里可以解释复杂的逻辑
*/

3.3 文档注释

/** 开头,*/ 结尾,可以用 javadoc 工具生成 API 文档。通常放在类、方法、字段前面,描述其功能。

/**
 * 这是一个文档注释示例
 * @author 你的名字
 * @version 1.0
 */
public class Hello {
    /**
     * 这是 main 方法的文档注释
     * @param args 命令行参数
     */
    public static void main(String[] args) {
        // ...
    }
}

注意:文档注释可以包含 @ 标签,如 @author@param@return 等,用于生成规范文档。

3.4 注释的作用

  • 解释代码意图:为什么这么写,而不是怎么写。
  • 调试:临时注释掉代码块,排查错误。
  • 生成文档:为其他开发者提供接口说明。

4. 代码规范:写出优雅的代码

良好的代码规范不仅让代码美观,更能减少错误、方便团队协作。以下是 Java 开发中常见的规范:

4.1 命名规范

类型规范示例说明
包名全部小写,用点分隔com.example.myapp公司域名倒写 + 项目名
类名大驼峰(每个单词首字母大写)HelloWorld, StudentManager名词或名词短语
方法名小驼峰(首字母小写,后续单词首字母大写)getName, calculateTotal动词或动词短语
变量名小驼峰studentName, totalCount有意义的名称
常量名全部大写,单词间用下划线MAX_VALUE, PI使用 final 修饰

4.2 缩进与空格

  • 使用 4 个空格 作为一个缩进级别,不要使用制表符(Tab),以保证在不同编辑器中显示一致。
  • 左大括号 { 可以放在行尾(K&R 风格)或另起一行,但团队内要统一。推荐放在行尾。
  • 操作符(如 =+-)两边加一个空格,提高可读性。
// 推荐
int sum = a + b;

// 不推荐
int sum=a+b;

4.3 空行与代码分组

  • 不同逻辑块之间用空行分隔。
  • 相关代码放在一起,例如先定义变量,再执行业务逻辑。
  • 方法之间通常用一个空行分隔。

4.4 注释规范

  • 每个类、方法、重要字段前使用文档注释。
  • 复杂的业务逻辑使用多行或单行注释解释。
  • 避免无意义的注释(如 i++; // i加1),注释要说明“为什么”,而不是“是什么”。

4.5 其他

  • 一行不要过长(通常不超过 80-120 字符),过长的表达式要换行。
  • 类名、方法名要见名知意,不要用拼音或无意义的字母。
示例:规范的代码
/**
 * 学生类,表示一个学生实体
 */
public class Student {
    private String name;  // 姓名
    private int age;      // 年龄

    /**
     * 构造方法
     * @param name 学生姓名
     * @param age  学生年龄
     */
    public Student(String name, int age) {
        this.name = name;
        this.age = age;
    }

    /**
     * 获取学生信息
     * @return 格式化的字符串
     */
    public String getInfo() {
        return "姓名:" + name + ",年龄:" + age;
    }
}

5. 总结与下期预告

今天的内容虽然偏基础,但非常实用:

  • DOS 命令 让你能高效地在命令行操作文件,是编译运行 Java 的必备技能。
  • 转义字符 让你能在字符串中灵活表达特殊符号。
  • 注释 是代码的说明书,让代码更易读。
  • 代码规范 帮助你写出专业、可维护的代码。

从下一篇开始,我们将正式进入 Java 语法核心,学习变量、数据类型和运算符,你会开始编写更有逻辑的程序。

动手实践

  1. 在命令行中练习 DOS 命令,创建文件夹、切换目录。
  2. 编写一个程序,用转义字符输出一个简单的表格(如课程表)。
  3. 给你的程序添加适当的注释,并检查是否符合命名规范。

如果有任何问题,欢迎在评论区留言。我们下期见! 🚀