【Java基础笔记】1-1 注释

§1-1 注释

注释是程序员在编写程序时为方便阅读和理解，在代码中插入的解释文字，注释不会被编译器编译，而是会在编译过程中被忽略。为使开发更易进行，也为使多人协同开发时的开发工作有序进行，建议在编写程序时多写注释文字。

Java 语言中的注释有三种：单行注释、多行注释、文档注释。下面将介绍注释的添加方法。

目录

• §1-1 注释
  • 1-1.1 创建项目
  • 1-1.2 创建项目和模块中可能出现的问题
  • 1-1.3 单行注释
  • 1-1.4 多行注释
  • 1-1.5 文档注释

1-1.1 创建项目

在先前的章节，我们通过直接在新建项目时选择 Java 项目以直接创建 Java 项目，在本章节中，我们将介绍另外一种创建项目的方式。

1. 创建空项目： New Project -> Empty Project

   此时创建出来的项目是无法进行代码键入的。因此我们需要新建模块（module）

2. 在新建好的项目文件中，选择File --> Module

3. 在弹出的菜单左栏选择Java，在右方选择你所安装的 Java 版本，单击下一步，如图所示：

   

4. 至此，模块创建完成，在src文件夹下创建类，这里以Hello, world!为例：

   

5. 运行程序，查看是否可正常运行

1-1.2 创建项目和模块中可能出现的问题

当一切准备完毕，开始运行程序时，可能会发生一些错误，这里列出两个错误并提供解决方法。

1. 提示java:JDK isn't specified for module 'JavaSE'

   • 按下组合键Ctrl + Alt + Shift + S呼出 Project Structure 对话框

   • 在左栏选择Modules，如图所示操作：

     

2. 提示Output directory is not specified

   • 若类文件不是在已新建模块的基础上创建，则需要手动在工程项目下创建目录%Root%\out\production

   • 可也以新建模块后在 Project Structure 下调整设置，如图所示：

     

当一切准备就绪后，我们可以尝试在Hello, world中添加注释了。

1-1.3 单行注释

用法：//注释文字

1-1.4 多行注释

用法：/* 多行注释 */

1-1.5 文档注释

用法：/** 文档注释 */

与以上两种注释方法不同的是，文档注释支持在其中引用参数。