您的位置:首页 > 编程语言 > Java开发

Java学习总结之注释相关

2013-09-12 20:34 253 查看
注释有三种:

单行注释:以//开头,大多用在属性后面或方法前一行,用来说明属性或方法的作用,这种用法并不太正式,只是开发人员自己看。或者用来注释掉某一行,使该行代码失效。

多行注释:一种是以  /* 开头,以 */  结尾,大多只是用来注释掉一段代码,使该部分代码失效,其他很少用

                   另一种是以/** 开头,以 */ 结尾,前两种编译器直接跳过,而这种编译器可以识别,用来生成javadoc文档;用在方法前,在别人调用这个方法的时候,当鼠标移上去,可以显示编写的注释。主要用在文件开头,类前,方法前,来对文件、类、方法进行说明。此类注释一般写在需要暴露的接口也就是public 类型的方法和变量上,因为不需要对外暴露的接口,不需要写在javadoc 文档中。

生成javadocs文档注释的方法是在项目菜单栏中点project,选generate  javadocs

格式:

        文档注释:

       /**

      * 文 件 名 :

       * CopyRright
      * 文件编号:
      * 创 建 人:
      * 日 期:
      * 修 改 人:
      * 日 期:
      * 描 述:
      * 版 本 号:
      */
 
       方法注释:
      /**
      * 方法名
     
* @param    参数说明
     
* @return     返回值说明
      * 方法作用
      */
 
除了注释之外,还有注解,注解同注释一样不会影响程序的运行,但是不同的是,在编译时,注释是丢掉不用,而注解则会进行特殊处理。
比如@override,这一项出现在方法声明的前一行,表明接下来这个方法是继承父类的,若是父类中没有这个方法,在编译时就会报错。
比如toString方法,若是不小心写成ToString,编译器会根据@override注解在父类(包括祖先)中寻找ToString方法,没有找到则报错 
 
内容来自用户分享和网络整理,不保证内容的准确性,如有侵权内容,可联系管理员处理 点击这里给我发消息
标签:  java 注释