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、方法註釋

聲明好方法後,在向方法裏寫實現的代碼前,在方法前

/** 回車

 

 

 

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章