注释的作用
注释在编程语言中虽不体现在运行中却为我们提供了很多的便利。人们往往不能清晰而准确地记忆曾编写代码的内涵和表达的含义,高级代码的编写代码行便是肉眼可见的“长篇大论”,很多甚至可以达到几十万行之多,这时便能体现出注释的重要性。我们所处的时代是一个技术更新很快,bug需要实时更新修补,软件需要实时维护升级的快节奏高技术时代,对于一个编写好的软件或者代码我们需要时常对其进行修改和增添。而在进行修改和增添之前要求我们首先需要读取源代码机器中所表达的含义,所以为了提高代码的逻辑性和可读性提高人们编写和修改代码的效率, 且便于后期维护和升级、提高产品的开发效率,注释便应运而生且被委以重任。现在我们就来详细地解读Java的注释。
我们还是采用简单的HelloWorld为例子来阐述我们的观点,在Java语言中注释大致可以分为三类:
- //单行注释(适用于单行代码,且该种注释不会在生成的javadoc文档中以文本形式体现出来,如果在该行编写完成一句注释之后回车换行继续编写将会出现错误);
- /…/多行注释(这种注释同样不会出现在javadoc生成的文件中,且这种方发对于格式要求较为严格)
- /**…*/多行注释(该种方法编写的注释将会体现在javadoc生成的文件中)
接下来是具体操作
单行注释
public class HelloWorld{
public static void main(String [] args){
System.out.println("HelloWorld");//this is a comend
}
}
多行注释
/**
*this is a commend
*aaa
*/
public class HelloWorld{
public static void main(String [] args){
System.out.println("HelloWorld");//this is a comend
}
}
多行注释(特别注意*的上下对齐)
/*
*this is a commend
*aaa
*/
public class HelloWorld{
public static void main(String [] args){
System.out.println("HelloWorld");//this is a comend
}
}
接着打开dos窗口执行生成javadoc文件
接着在c盘中找到help文件,
然后找到index.html文件
然后出现如下界面
我们可以清晰地看到/**…*/类注释可以在javadoc文件中体现出来。