遇到过很多JAVA或者其他编程初学者有一个小烦恼,那就是:我能不能给我写的这么多代码都弄一个标注、解释说明啥的,方便我后面快速看出这里的功能或者一些需要说明的东西。那么接下来就来教你如何在代码中添加注释以及快捷键添加注释!
注释的内容是完全不会被编译器编译的,也就是说对于代码而言,那就是空气,无论你在注释里怎么写代码或者其他的,和运行以后的结果没有半毛钱关系!
首先JAVA中注释分为三种:
单行注释、多行注释、以及文档注释。如下:
//单行注释 快捷键(Windows):Ctrl + /
/*
* 多行
* 注释 快捷键(Windows):Ctrl + Shift + /
* */
/**
* 文档
* 注释
* */
关于三种注释的选择:
一般情况下建议使用单行注释,这样可以让代码看上去更加整洁,并且不容易造成代码的混乱。比如这样:
public static void main(String[] args) {
//输出Hello World!
System.out.println("Hello World!");
}
而多行注释则适用于说明文字是一大段的代码:
public static void main(String[] args) {
/*
* 利用System.out.println()输出(换行)
* 输出内容是:Hell World!
* System.out.print()则是输出完不换行
* */
System.out.println("Hello World!");
}
文档注释的话多用于实际软件开发,像@param x
这样的标记是用来说明参数类型、返回值、方法说明等,初学者一般重点掌握单行注释和多行注释即可。如下是.println
的源码以及注释:
/**
* Prints a String and then terminate the line. This method behaves as
* though it invokes <code>{@link #print(String)}</code> and then
* <code>{@link #println()}</code>.
*
* @param x The <code>String</code> to be printed.
*/
public void println(String x) {
synchronized (this) {
print(x);
newLine();
}
}
小拓展(TODO)
TODO 加在你的注释符号的后面(多行是在 /*
后面),就可以实现一个“标记”的效果,你可以通过底部工具栏TODO来快速定位你做过标记的位置,用起来还是非常方便的!
public static void main(String[] args) {
//TODO 这里需要加上输出的内容
/*TODO
* 这里需要加上输出的内容
* */
System.out.println("");
}
感谢阅读!有问题欢迎评论或者私聊哟!点个关注?点个赞?