欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  Java

Java中的单行注释和多行注释

程序员文章站 2022-04-09 14:26:48
...
在编程中,注释是必不可少的一部分,注释一方面可以看清代码的结构,找起来更方便,另一方面,也有利于同事之间的工作交接。那么今天就和大家聊聊Java中的单行注释和多行注释吧,有需要的朋友可以参考一下,希望对你有所帮助。

什么是注释?注释就是一段文字,这段文字并不是必须的,也不直接参与代码运行。

注释用来说明某段代码的作用,或者说明某个类的用途,每个方法的功能,以及该方法的参数和返回值的数据类型及意义等。

为什么要添加注释?

1,永远不要过于相信自己的理解力。为了过段时间还能简单明了的看懂自己的以前的代码,建议添加注释。
2,可读性第一,效率第二。团队协同开发中,团队成员的沟通比较重要,为了自己写的代码能被整个团队理解,建议添加注释。
3,代码即文档。自己平时写一些代码,为了生成一些规范的文档,建议添加注释。

实际工作中,经常会听到一些同事说别人的代码没注释怎么怎么样,实际上写的漂亮的代码不需要太多的注释,相反的,我个人对于满屏幕的注释或者是一些无用的代码极其反感,特别是使用git,svn等工具做版本管理之后,我都会把那些无用的注释掉的代码全部删掉。

这里整理一下我对注释的个人理解:

1,必要的注释还是必须要有的,比如说Javabean中的字段意义,就应该有相关的注释。比如说一些编码中暂时实现功能,但是存在一些不好的待优化的地方,我一般会写一个TODO,实现基本功能后续我自己再回过头来完善。
2,不要写一些白痴的无用注释,不要保留任何一行被注释掉的代码,现在代码一般都有版本工具做管理,所以根本不用担心代码会丢掉。
3,严格的遵守Java的命名规范,不用担心变量名称太长,不用担心方法名称太长,合理的一个英语的翻译命名比写那些无用的汉语注释强多啦。

程序注释是源代码的一个重要部分,对于一份规范的程序源代码来说,注释应该占到源代码的三分之一左右。

几乎所有的编程语言都提供了注释的功能,一般的编程语言都提供了基本的单行注释和多行注释,Java也不例外。除此之外,Java语言还提供了一种文档注释。

这篇博客先整理一下Java中的单行注释和多行注释,文档注释一般用来生成API。

单行注释和多行注释

单行注释就是在程序中注释一行代码,在Java语言中,将双斜线"//"放在需要注释的内容之前就可以啦。

在eclipse中,单行注释的快捷键是command+/,按一次是添加注释,在按一次就是取消注释。

多行注释就是一次性的将程序中的多行代码注释掉,在Java语言中,使用"/*"和"*/"将程序中需要注释的内容包含起来,"/*"表示注释开始,"*/"表示注释结束。

在eclipse中,多行注释的快捷键是command+control+/,使用的时候要选中代码,我一般很少用多行注释。

现在贴出一段代码,来演示一下Java中的单行注释和多行注释。

/**
 * Java的单行注释和多行注释.
 * 
 * @author LinkinPark
 */
public class Comment
{
 public static void main(String[] args)
 {
  // 这里是Java的单行注释
  System.out.println("演示Java的单行注释。。。");
  /*
   * 这里是Java的多行注释
   */
  System.out.println("演示Java的多行注释。。。");
 }
}

以上就是Java中的单行注释和多行注释的详细内容,更多请关注其它相关文章!

相关标签: Java,注释