注释规范
1、在java语言中注释的方式
1.1、在//的后面写注释(这个和c++一致)。
1.2、在/* */中间写注释。
1.3、文档注释 在/** */中间写注释,这个感觉目前用不到,了解即可。
注意:a、在//同一行后面的全都不执行,例如//main(),////。在单行注释中是可以写单行注释的。
b、在 /* */中可以添加//注释,例如/*
/////w adad
*/在多行注释中可以添加单行注释
c、在/* */中不可以添加/* */ ,例如/* /* */ */ 这样是报错的。在多行注释中不可以写多行注释。
2、注释的意义
2.1、告诉代码者思路(方便编写和阅读)。即使是自己写的代码,如果没写注释,三天过后可能自己都不知道自己写的是什么。当工作人员离职的时候,接受的人由于很难看懂带码而特别头疼,因此注释是一个初学者很容易忽略而又很重要的问题。
2.2、调试程序。当注释完一段话不报错了,但消除注释后报错,说明肯定是注释的地方出错了。
3、比较标准的注释应该怎么写
/*
1、需求:。。。。。。。(简单描述一下需求和重点)
2、思路:自己算法的思想(用什么原理实现这个方法)
3、如何实现(定义一个什么类,用了什么数组)和比较关键代码处给予解释。
*/