一個(gè)程序的可讀性，關(guān)鍵取決于注釋。如果一個(gè)程序想二次開發(fā)，要讀懂前面的程序代碼，就必須在程序中有大量的注釋文檔，所以對于一個(gè)優(yōu)秀的程序員來說，學(xué)會(huì)在程序中適當(dāng)?shù)靥砑幼⑨屖欠浅Ｖ匾摹?/p>

注釋除了幫助別人了解編寫的程序之外，還對程序的調(diào)試、校對等有相當(dāng)大的幫助。當(dāng)程序具體運(yùn)行時(shí)，計(jì)算機(jī)會(huì)自動(dòng)忽略注釋符號(hào)之后所有的內(nèi)容。教程第二章中曾經(jīng)提到過注釋，讀者也許印象不太深，在這里復(fù)習(xí)一遍。

本節(jié)將簡單地介紹類、方法、字段等地方的注釋方法，這些地方的注釋雖然簡單但是在開發(fā)工作中卻是非常重要的。

注意：本節(jié)注釋使用文檔注釋。多行注釋的內(nèi)容不能用于生成一個(gè)開發(fā)者文檔（文檔提供類、方法和變量的解釋，也可稱為幫助文檔），而文檔注釋可以。

1. 類注釋

類注釋一般必須放在所有的“import”語句之后，類定義之前，主要聲明該類可以做什么，以及創(chuàng)建者、創(chuàng)建日期、版本和包名等一些信息。以下是一個(gè)類注釋的模板。
/**

• @projectName（項(xiàng)目名稱）: project_name
• @package（包）: package_name.file_name
• @className（類名稱）: type_name
• @description（類描述）: 一句話描述該類的功能
• @author（創(chuàng)建人）: user
• @createDate（創(chuàng)建時(shí)間）: datetime
• @updateUser（修改人）: user
• @updateDate（修改時(shí)間）: datetime
• @updateRemark（修改備注）: 說明本次修改內(nèi)容
• @version（版本）: v1.0
  */
  提示：以上以@開頭的標(biāo)簽為 Javadoc 標(biāo)記，由@和標(biāo)記類型組成，缺一不可。@和標(biāo)記類型之間有時(shí)可以用空格符分隔，但是不推薦用空格符分隔，這樣容易出錯(cuò)。

一個(gè)類注釋的創(chuàng)建人、創(chuàng)建時(shí)間和描述是不可缺少的。下面是一個(gè)類注釋的例子。

/*** @author: zhangsan* @createDate: 2018/10/28* @description: this is the student class.*/ public class student{................. }

注意：沒有必要在每一行的開始用*。例如，以下注釋同樣是合法的：

/**@author: zhangsan@createDate: 2018/10/28@description: this is the student class.*/ public class student{................. }

2. 方法注釋

方法注釋必須緊靠在方法定義的前面，主要聲明方法參數(shù)、返回值、異常等信息。除了可以使用通用標(biāo)簽外，還可以使用下列的以@開始的標(biāo)簽。

• @param 變量描述：對當(dāng)前方法的參數(shù)部分添加一個(gè)說明，可以占據(jù)多行。一個(gè)方法的所有
• @param 標(biāo)記必須放在一起。
• @return 返回類型描述：對當(dāng)前方法添加返回值部分，可以跨越多行。
• @throws 異常類描述：表示這個(gè)方法有可能拋出異常。

下面是一個(gè)方法注釋的例子。

/*** @param num1: 加數(shù)1* @param num2: 加數(shù)2* @return: 兩個(gè)加數(shù)的和*/ public int add(int num1,int num2) {int value = num1 + num2;return value; }

以上代碼的 add() 方法中聲明了兩個(gè)形參，并將它們兩個(gè)的和作為返回值返回。

為類的構(gòu)造方法添加注釋時(shí)，一般聲明該方法的參數(shù)信息，代碼如下。

public class Student {String name;int age;/*** @description: 構(gòu)造方法* @param name: 學(xué)生姓名* @param age: 學(xué)生年齡*/public Student(String name,int age) {this.name = name;this.age = age;} }

3. 字段注釋

字段注釋在定義字段的前面，用來描述字段的含義。下面是一個(gè)字段注釋的例子。

/*** 用戶名*/ public String name;

也可以使用如下格式：

/**用戶名*/ public String name;

在 Java 的編寫過程中我們需要對一些程序進(jìn)行注釋，除了自己方便閱讀，更為別人更好理解自己的程序。

總結(jié)

以上是生活随笔為你收集整理的1.14 Java注释：类、方法和字段注释的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。