Java由小白到高手之零基础学Java——第二课 Java控制台程序中的输出语句及注释

---

  跟着磊哥学Java系列为Java基础入门系列。通过此系列，我们将了解Java基础知识，包括变量、数据类型、运算符，选择结构、循环结构、数组等基本知识。此系列总结磊哥多年的经验，采用边讲边练的方式一起带领零基础的朋友走进Java世界。


  本系列每章都会有大量的练习题，请大家在学习过程中，认真的进行练习，并和我提供的参考代码比较，反复感悟。要把一门语言学好，只学不悟是不可能学好的，用心自我”感悟“，多练，多想是学好一门语言的基础。

  这是本系列的第二章
  您也可以通过下面连接查看其它章节

  Java由小白到高手之零基础学Java系列目录

---

Java控制台输出语句

输出不换行

语法：System.out.print(“要输出的字符串”）;
**作用：**向控制台输出小括号中的字符串，输出后不换行。
**注意：**Java中的字符串必须用英文双引号包围。

例如：我们在记事本中写入下面代码

public class   MyFirstProgram   {
	public static void main(String[] args)  {
		//代码中写了两行输出语句
		System.out.print("HelloJava");
		System.out.print("HelloWorld");
	}
}

运行结果如下，我们看到print 方法输出是不换行的。

输出并换行

语法：System.out.println(“要输出的字符串”）;
**作用：**向控制台输出小括号中的字符串，输出后换行，即在输出后多输出一个换行符。
**注意：**Java中的字符串必须用英文双引号包围。

例如：我们在记事本中写入下面代码

public class   MyFirstProgram   {
	public static void main(String[] args)  {
		//代码中写了两行输出语句
		System.out.println("HelloJava");
		System.out.println("HelloWorld");
	}
}

运行结果如下，我们看到println方法输出后加了换行符。

Java中的转义符

   如果我们想输出英文的双引号等特殊字符如何做呢？在Java中我们可以通过转义符输出，转义符的引导符为“\”，如果我们想输出英文双引号就要按下面方法进行：

public class   MyFirstProgram   {
	public static void main(String[] args)  {
		
		System.out.println("\"");
		
	}
}

输出结果为：

Java中常见的转义符

转义符	说明
\b	退格符
\n	换行符
\r	回车符
\"	英文双引号
\’	英文单引号
\\	反斜线
\t	一个制表位（相当于按一下键盘上的tab键一次）

思考？
能不能用System.out.print()方法实现和System.out.println()方法一样的效果呢？
相信聪明的你一定想出了方法，下面是其中的一种

public class   MyFirstProgram   {
	public static void main(String[] args)  {
		
		System.out.print("Hello Java\rHello World");
		
	}
}

练习一

  请按下图的格式在控制台输出相应内容（因记事本编码问题，我们暂不输出中文，除非你知道如何调整记事本的编码）：

  聪明如你，一定运行出了正确的结果。你也可以看一下文末的参考代码。

---

Java中的注释

  注释在程序中是给我们程序员看的，Java编译时，不会对注释进行任何操作。写注释是写源码的一部分，一个良构的程序，注释应约占总代码量的1/3 左右。注释应实现以下作用：

  1. 写在类上（如我们上面写的代码中：class MyFirstProgram就是类)或方法（如我们上面写的代码中 main(String[] args)就是一个方法）的注释应注明类或方法的作用。
  2. 写在方法中的注释应是业务的思路（我们在今后的学习中会不断的学习）
  3. 写在变量中的注释应注明变量的作用(下章开始我们将学习变量)

  Java语言中的注释共分三种

• 单行注释
• 多行注释
• 文档注释

单行注释和多行注释

  - 单行注释以//开头 后面写注释内容。
  - 多行注释以 /*开头，以*/ 结束。
下图是添加了注释的代码：

public class   MyFirstProgram   {
	/*
	* main方法是程序的入口
	* main方法的四要素缺一不可
	* public 表示main方法是公有的
	* static  是静态方法，我们在后续将学习
	* void 表示方法不对外提供数据，我们后续将学习
	* 小括号中的String[] args 是参数，表示方法将从外部接收数据
	* 现在演示的的Java的多行注释，而不是文档注释，多行注释斜线后是一个＊号
　　 * 中间每行的*号是为了好看，不是必须。
	*/	
	public static void main(String[] args)  {
		//向控制台中输出name和age，并输出一个空行
		System.out.println("name\t\t\tage\n");
		
		System.out.println("LeiGe\t\t\t18");
		System.out.println("My name is LeiGe\t18");

		
	}
}

文档注释

  文档注释的作用很大，很强。下面描述中出现的新名词，大家可以先记忆，不用去理会，在后续的学习中，我们会逐渐的学习，在今后的学习中磊哥也会不断的强化注释。

• 在类、方法、属性上的文档注释的类或方法的描述，可以在开发工具中生成提示信息。
• 在类、方法、属性上的文档注释可以通过javadoc命令生成帮助手册（API) 。
• 文档注释以 /**开头（注意是两个*），以 */ 结束。
• 文档注释支持html语言。
• 文档注释写法很专业，今天我们只简单了解，在后续学习中，我们还会不断的了解文档注释，以生成更专业的API手册

  下面示例给类和方法添加了文档注释，注释中的<p></p>,<a …></a>等为html代码，主要是为了在帮助文档中用，不了解可忽略，注释一般分为三部分：

• 第一部分写类或方法的概要功能
• 第二部分写类或方法的详细功能
• 第三部分写类或方法的标注

  文档注释常见的标注：(除第一个和第二个外，其它大家仅需了解，在随后的学习过程中，我们会继续深化)

@author 程序的作者
@version 程序的版本
@param 程序的参数，有写，没有不写
@return 程序的返回值，有写，没有不写

/**
* <p>写在类第一行的文档注释应是类的作用.</p>
* 
* <P>空一行后这里写类的详细作用，支持html语法比如写上：</P>
* <p>欢迎访问<a href="https://blog.csdn.net/weixin_42452652">彦磊的博客</a></P>
* <p>其后可以写明作者等信息</p>
*
*<p>空一行后写文档标注，如作者、版本等</p>
* @author 彦磊
* @version 1.0
*/
public class   MyFirstProgram   {
	/**
	* <p>写在方法文档注释第一行的是方法的概要作用.</p>
	* 
	* <p>空一行后写方法的详细作用</P>
	* <p>程序的入口.</p>
	* 
	* <p>空一行后写文档的标注，如参数、返回值等.</p>
	* @param args  接收从控制台传入的参数.
　　* 
	*/	
	public static void main(String[] args)  {
		//向控制台中输出name和age，并输出一个空行
		System.out.println("name\t\t\tage\n");
		
		System.out.println("LeiGe\t\t\t18");
		System.out.println("My name is LeiGe\t18");

		
	}
}

---

javadoc命令简介

  文档注释写完后，我们可以使用javadoc命令来生成API。

  java中的每个命令后加 -help参数都可获取到命令的使用帮助，下图演示了获取帮助的命令及部分帮助信息


  今天我们重点了解部分参数

语法：javadoc -d 要生成的帮助文档所在目录 -author -version -windowtitle 要生成API的文档


参数解释：
-d 输出文档的目标路径，即要生成的帮助文档所在目录。
-author 包含 @author 段。
-version 包含 @version 段。
-windowtitle 文字 浏览器窗口显示的标题。
-要生成API的文档 对哪些文件生成文档。
每个参数中间都需要由空隔间分隔。


示例:
*javadoc -d d:\javaProject\doc -author -version -windowtitle 我的第一个API .java
上面命令的作用是：为当前目录下所有的扩展名为.java的文件，在d盘javaProject的doc目录中生成帮助文档，帮助文档显示的标题为"我的第一个API",显示版本号和作者。

下图演示了执行上述命令的过程。

执行成功后会在DOC目录下生成API文档

我们双击index.html就能打开我们的帮助文档了。

下面我们一一把注释和最终的效果对应一下，以更好理解文档注释。
点击“程序包",出现下图，我们对应类的文档注释的第一行显示内容

点击上图绿框框住的类名，进入类的详细描述页面，如下图，请仔细对照：

点击上图绿框框住的文字，我们来对照方法的文档注释

练习二

  本阶段我们学习Java中的注释，重点了解了文档注释及javadoc命令生成API。通过下面练习来验证一下，你是否掌握了吧。

1. 在练习一的基础上，为第一个输出语句添加多行注释，详细描述\t \n的作用及为什么添加多个\t。
2. 在练习一的基础上，为第二个及第三个输出语句分别添加单选注释，描述语句的作用。
3. 在练习一的基础上，为MyFirstProgram类加文档注释，需要有概要描述、详细描述、版本号及作者
   4.在练习一的基础上，为main方法添加文档注释，需要有概要描述、详细描述和参数标注。
   5.添加完注释后，再次对类进行编译运行，不能出错。

练习三

  在练习二的基础上完成练习三：

1.使用javadoc命令生成类的API。
2.打开API文档，对各种描述及标注进行一一对应，加深对文档注释的理解 。

---

总结

  到此，今天的内容就已经结束了，下面的思维导图是今天的总结 ：

---

  欢迎大家在评论中提出自己的建议及想和磊哥交流的问题，我将及时和大家交流。欢迎大家关注磊哥的博客，您将快速得到我的更新

---

练习参考代码

练习一参考代码

public class   MyFirstProgram   {
	public static void main(String[] args)  {
		//行末的\n是为了多输出一个换行符
		//由于My name is LeiGe比较长，因此在name后加了三个\t，用于对齐制表位。
		System.out.println("name\t\t\tage\n");
		System.out.println("LeiGe\t\t\t18");
		System.out.println("My name is LeiGe\t18");
	}
}

练习二参考代码

/**
* <p>写在类第一行的文档注释应是类的作用.</p>
* 
* <P>空一行后这里写类的详细作用，支持html语法比如写上：</P>
* <p>欢迎访问<a href="https://blog.csdn.net/weixin_42452652">彦磊的博客</a></P>
* <p>其后可以写明作者等信息</p>
*
*<p>空一行后写文档标注，如作者、版本等</p>
* @author 彦磊
* @version 1.0
*/
public class   MyFirstProgram   {
	/**
	* <p>写在方法文档注释第一行的是方法的概要作用.</p>
	* 
	* <p>空一行后写方法的详细作用</P>
	* <p>程序的入口.</p>
	* 
	* <p>空一行后写文档的标注，如参数、返回值等.</p>
	* @param args  接收从控制台传入的参数.
　　　　　* 
	*/	
	public static void main(String[] args)  {
		/*
		* 向控制台中输出name和age，并输出一个空行
		* \t 的作用是输出一个制表位
		* \n的作用是输出一个换行符
		*/
		System.out.println("name\t\t\tage\n");
		//换行输出LeiGe及18，并用制表位和上一行对齐
		System.out.println("LeiGe\t\t\t18");
		//换行输出My name is LeiGe及18，并用制表位和上一行对齐
		System.out.println("My name is LeiGe\t18");

		
	}
}

练习三参考代码

D:\javaProject>javadoc -d d:\javaProject\doc -author -version -windowtitle 我的第 一个API  *.java