JAVA复习笔记--第一章：第一节：从注释开始

java注释分以下三种注释：

1、单行(single-line)--短注释：//……   
2、块(block)--块注释：/*……*/
3、文档注释：/**……*/

一、单行注释

1、单行注释(Single-Line Comments)：

短注释可以显示在一行内，并与其后的代码具有一样的缩进层级。

如果一个注释不能在一行内写完，就该采用块注释。

单行注释之前应该有一个空行。

例：

 if (condition) {
 

    /* Handle the condition. */

    ...

  }

eclipse快捷键：Ctrl+Shift+/ Ctrl+Shift+\

2、尾端注释(Trailing Comments)：

尾端(trailing)--极短的注释，在代码行的行尾进行注释。

建议：一般与代码行后空8（至少4）个格，所有注释必须对齐。

例：

  if (a == 2) {

      return TRUE;              /* special case */

  } else {

      return isPrime(a);         /* works only for odd a */

  }

eclipse快捷键：Ctrl+Shift+/ Ctrl+Shift+\

3、行末注释：

在代码行的开头进行注释。主要为了使该行代码失去意义。
注释格式：// 注释内容

建议：在代码中单起一行注释， 注释前最好有一行空行，并与其后的代码具有一样的缩进层级。如果单行无法完成，则应采用块注释。

如：

风格一： 

 if (foo > 1) {

      // Do a double-flip.

      ...

  }

  else {

      return false;          风格二：// Explain why here.

  }

风格三:

  //if (bar > 1) {

  //

  //    // Do a triple-flip.

  //    ...

  //}

  //else {

  //    return false;

  //}

 

Ctrl+Shift+C  或者 Ctrl+/ 再按一次取消

二、块注释

注释若干行，通常用于提供文件、方法、数据结构等的意义与用途的说明，或者算法的描述。一般位于一个文件或者一个方法的前面，起到引导的作用，也可以根据需要放在合适的位置。这种域注释不会出现在HTML报告中。注释格式通常写成：

快捷键：Ctrl+Shift+/  Ctrl+Shift+\

三、文档注释

注释若干行，并写入javadoc文档。每个文档注释都会被置于注释定界符

avadoc注释标签语法

1、接口或类中使用 

@see       对类、属性、方法的说明 参考转向，也就是相关主题
@author    对类的说明 标明开发该类模块的作者
@version   对类的说明 标明该类模块的版本

@deprecated:不推荐使用的方法或类

2、方法中使用

@deprecated:不推荐使用的方法

@see      对类、属性、方法的说明 参考转向，也就是相关主题
@param    对方法的说明 对方法中某参数的说明
@return    对方法的说明 对方法返回值的说明
@exception  对方法的说明 对方法可能抛出的异常进行说明

@throws 同exception

 

3、字段上使用

@deprecated:不推荐使用的方法

@see      对类、属性、方法的说明 参考转向，也就是相关主题

 

1、开头注释(Beginning Comments)

所有的源文件都应该在开头有一个C语言风格的注释，其中列出类名、版本信息、日期和版权声明：

  /*
   * Classname
   *
   * Version information
   *
   * Date
   *
   * Copyright notice
   */

2、包和引入语句(Package and Import Statements)

我常用的快捷键：Ctrl+Shift+O

 

3、类和接口声明(Class and Interface Declarations)

快捷键:Alt+Shift+J

/**
 * @Copyright 

 * @Description
 * @author 逍遥客
 * @date 2013-5-23 上午12:43:22  
 * @version V1.0    
 */

 4、方法注释

声明好方法后，在向方法里写实现的代码前，在方法前

/** 回车