java基础-注释

有没有想过一段程序有几千行代码，程序员是如何记住的呢？

• 那就要谈到注释的作用了。
• 注释：解释一段程序的作用
• 需要注意 : 注释 并非 注解(后续会学到)

进入正题

1. 注释并不会编译,注释数量的多少不影响程序的正常执行.
2. 注释中不能嵌套注释

注释有三种表示方式.

代码	解释	语法	作用
// 你好我是单行注释	单行注释	以 // 开头	从 // 开始到本行结束
/* 你好,我是多行注释 */	多行注释	/* 开头 , */ 结尾	从 /* 开始 到 */ 结束
/** 你好,我是文档注释 */	文档注释	/** 开头 , */ 结尾	从 /** 开始 到 */ 结

1. 单行注释

public static void main(String[] args){
	System.out.println("hello,world");		//将hello,world打印到控制台
}

2. 多行注释 ( 多行注释也可以注释一行)

public class HelloWorld{
	/**
		* 这是多行注释,在这个范围内,注释都是成立
		* 下面的是main方法 , 是程序的路口.
		*/
	public static void main(String[] args){
		/* 将hello,world 输入到控制台中 */
		System.out.println("hello,world");
	}
}

程序示例:

• 找到我们昨天写的java程序 --> 右键 --> 选择Edit. ( 如果没有也没有关系,将后缀名 改成 .txt 即可)
  
• 在文件中,给代码添加上注释(一定要养成这个良好的习惯)

public class Helloworld{
	/*
	* 这是main方法,又叫主函数
	*/
	public static void main(String[] args){
		System.out.println("Hello,world");		//将Hello,world打印到控制台中
		//System.ou.println("你好,我是注释");
	}
}

• 开始编译文件 ( 如果代码有改动,则需要重新编译)
  
• 开始运行,可以看到注释并没有进行运行.
  

3. 文档注释

	/**
	* 这是 HelloWorld 类 , 我是文档注释.
	* @author 作者名称
	* @version 版本号
	* 
	*/
	public class HelloWorld{
		public static void main(String[] args){
			System.out.println("Hello,World");
		}
	}

• 进入cmd命令窗口
• 在java文件夹下 , 新建一个用于存储java文档的文件夹
  
• 输入命令 javadoc -d 文档存放的地址 需要生成的java文件
  
• 打开文件夹
  
• 在里面找到 index.html 打开即可.
  

看不懂这个文档没有关系,通过后面的学习,就能看懂了.这里了解即可.

今天的内容就到此为止了.