小白java程序注释

程序注释

​ 任何一套程序代码里面实际上都会由大量的程序逻辑所组成，但是如果要想对一套代码进行长期的维护，就需要编写大量的注释，对一些程序的代码功能要进行详细的解释，这样不仅为自己铺平道路，实际上也为后来接手的工程师铺平道路。

关于注释的笑话：有一位程序员到一家新的公司进行项目开发，突然有一天老板说，某一个功能执行的速度实在是太慢了，让这位程序员修改一下，后来这个程序员找到了相关源代码，里面写上了一个注释“后面的兄弟，悠着点，我在这里吗让代码延迟了3秒，别一下子改的太快了，给后面的兄弟留点发挥空间”，于是这位工程师根据前辈的注释进行了修改，将原始的延迟3秒，修改为了延迟2.5秒，速度变快了，老板给了奖金。

​ 在Java程序里面针对于代码的注释一共提供了三种注释形式：

• ​ 单行注释：“// 注释内容";（考虑到开发工具的代码格式化问题）

• ​ 多行注释：“/*… 注释内容 … */";

• ​ 文档注释：“/** … 文档注释的特定语法标记进行注释的编写 …… */”，这种注释往往可以结合开发工具使用

public class YootkDemo{ // 【单行注释】定义程序的执行主类
	public static void main(String args[]){// 【单行注释】程序的执行起点，主方法
		/*【多行注释】
			以下的程序代码是在屏幕上进行一些提示信息的输出，如果有需要则可以再里面进行多行的定义	
		*/
		System.out.println("Hello world!"); 
	}
}

​ 既然所有的注释文字不会自己进行代码的编译处理，所以在实际项目开发之中可以将一些暂时不需要的代码通过注释的形式让其失效，这种形式要比直接删除代码更高效。

public class YootkDemo{ // 【单行注释】定义程序的执行主类
	public static void main(String args[]){// 【单行注释】程序的执行起点，主方法
		/*【多行注释】
			以下的程序代码是在屏幕上进行一些提示信息的输出，如果有需要则可以再里面进行多行的定义	
		*/
		System.out.println("Hello world!"); 
		// 【代码失效】 System.out.println("江湖上称我为"); 
	}
}

在以后进行项目开发的时候，一些暂时不需要的代码就可以利用注释进行关闭。

个人博客