java版權注釋

❶ java 文檔注釋是注釋什麼的,不是有多行注釋了嗎

1、【文檔注釋】是寫在類或者方法的上面的。

文檔注釋可以用eclipse導出chm格式的幫助文檔，拿給其他人用時，方便他人理解。文檔注釋被調用的方法，當滑鼠移到上面時提醒注釋內容。

使用文檔注釋時，需要在開始的/**之後，第一行或幾行是關於類、變數和方法的主要描述。

之後，可以包含一個或多個何種各樣的@標簽。每一個@標簽必須在一個新行的開始或者在一行的開始緊跟星號(*)。多個相同類型的標簽應該放成一組。

2、【多行注釋】注釋的也是方法或類，言下之意就是一次性的將程序中的多行代碼注釋掉，但多行注釋的內容不能用於生成一個開發者文檔。

3、【多行注釋與文檔注釋的區別】多行注釋的內容不能用於生成一個開發者文檔，而文檔注釋 的內容可以生產一個開發者文檔。

(1)java版權注釋擴展閱讀

java常用的文檔注釋標簽

1、@author：標識一個類的作者

實例：@author description

2、@deprecated：指名一個過期的類或成員

實例：@deprecated description

3、@exception：標志一個類拋出的異常

實例：@exception exception-name explanation

4、{@inheritDoc}：從直接父類繼承的注釋

實例：Inherits a comment from the immediate surperclass.

5、{@link}：插入一個到另一個主題的鏈接

實例：{@link name text}

6、{@linkplain}：插入一個到另一個主題的鏈接，但是該鏈接顯示純文本字體

實例：Inserts an in-line link to another topic.

7、@param：說明一個方法的參數

實例：@param parameter-name explanation

8、@return：說明返回值類型

實例：@return explanation

9、@see：指定一個到另一個主題的鏈接

實例：@see anchor

10、@serial：說明一個序列化屬性

實例：@serial description

❷ java 注釋規范

/**
*方法功能描述
*
*@param參數說明
*@author作者
*@return返回格式
*@exception異常
*/

❸ java中 /** */注釋和 /* */注釋 有啥區別嗎

/** */注釋的話，你再調用類和方法的時候會出現提示，內容就是你寫的注釋。就好像文檔幫助一樣。類似"字元串".toString()，滑鼠放在toString()上時出現的api說明。
而/* */就沒有了。/* */就是//的多行版

❹ java中注釋的問題

DOC注釋/**------*/是完全為javadoc服務的會被編譯識別。

@打頭的表示註解，註解這個東西是JDK1.5提出來的，表示一個類(class)、欄位(field)或者方法(method)的屬性(attribute)。

javadoc是javaAPI的一種方便實現，主要是為了別人對此類的閱讀使用的方便，一般不影響類的功能。因為java之前的C/C++的api讓你閱讀起來非常不方便。

DOC注釋裡面的專門給出doc提示用的，如：注釋內的@return 表示方法的返回值類型，它是在方法上的doc註解，即使你這個上面隨便瞎寫，不會影響類的編譯和功能。

而在方法上面直接加的@Override，表示這個方法是覆蓋來自超類(super class)的已知方法。
如果方法定義和超類的這個方法格式不合適，編譯無法通過。

❺ java注釋

各公司都有不同要求，一般方法注釋需要註明該方法的作用，參數說明和返回值。有異常的要加異常說明。有時還要加上創建人，修改人和修改時間。
/**
* 對數組進行排序
* @author XXX
* @param 待排序數組
* @return 排序後的數組
*/

❻ 真正的開發中，java代碼要如何注釋

代碼注釋是架起程序設計者與程序閱讀者之間的通信橋梁，最大限度的提高團隊開發合作效率。也是程序代碼可維護性的重要環節之一。所以我們不是為寫注釋而寫注釋。下面說一下我們在訴求網二期開發中使用的代碼注釋規范，供大家參考下。
原則：
1、注釋形式統一
在整個應用程序中，使用具有一致的標點和結構的樣式來構造注釋。如果在其它項目中發現它們的注釋規范與這份文檔不同，按照這份規范寫代碼，不要試圖在既成的規范系統中引入新的規范。
2、注釋內容准確簡潔
內容要簡單、明了、含義准確，防止注釋的多義性，錯誤的注釋不但無益反而有害。
注釋條件：
1、基本注釋（必須加）
(a) 類（介面）的注釋
(b) 構造函數的注釋
(c) 方法的注釋
(d) 全局變數的注釋
(e) 欄位/屬性的注釋
備註：簡單的代碼做簡單注釋，注釋內容不大於10個字即可，另外，持久化對象或VO對象的getter、setter方法不需加註釋。具體的注釋格式請參考下面舉例。
2、特殊必加註釋（必須加）
(a) 典型演算法必須有注釋。
(b) 在代碼不明晰處必須有注釋。
(c) 在代碼修改處加上修改標識的注釋。
(d) 在循環和邏輯分支組成的代碼中加註釋。
(e) 為他人提供的介面必須加詳細注釋。
備註：此類注釋格式暫無舉例。具體的注釋格式自行定義，要求注釋內容准確簡潔。
注釋格式：
1、單行(single-line)注釋：「//……」
2、塊(block)注釋：「/*……*/」
3、文檔注釋：「/**……*/」
4、javadoc 注釋標簽語法
@author 對類的說明標明開發該類模塊的作者
@version 對類的說明標明該類模塊的版本
@see 對類、屬性、方法的說明參考轉向，也就是相關主題
@param 對方法的說明對方法中某參數的說明
@return 對方法的說明對方法返回值的說明
@exception 對方法的說明對方法可能拋出的異常進行說明

❼ 什麼是注釋如何在Java程序中加入注釋

試想一下，一個沒有一句注釋的程序源碼，怎麼讀，一個程序要上萬條代碼不可能全部記得住哪一塊是什麼用，而且一個項目也不會是一個人獨自完成，那樣效率太低，多人合作就要給別人說明，每一塊是什麼用，方便他人使用，方便自己更正，而這些說明文字就是注釋，注釋不會被執行，不影響運行結果。

Java中代碼的注釋有三種：

// 注釋一行
/* ...... */ 注釋若干行
/** ...... */ 注釋若干行，並寫入 javadoc 文檔

前兩種比較容易理解，至於第三種，你學習Java看的api文檔就是javadoc程序根據第三種的注釋生成的。

(7)java版權注釋擴展閱讀

注釋就是對代碼的解釋和說明，其目的是讓人們能夠更加輕松地了解代碼。注釋是編寫程序時，寫程序的人給一個語句、程序段、函數等的解釋或提示，能提高程序代碼的可讀性。

❽ java開發時怎麼自動添加註解

想要自動添加註釋，首先需要對eclipse進行一些設置。

打開Eclipse,然後點擊->windows->preferences->Java->code styles->code templates->comments->types->點擊右側的edit進行編輯，在打開的編輯窗口中修改下面的文字

/**
* @author ${user}
*
* ${tags}
*/
替換成

/**
* @author 你的名字
*
* ${tags}
*/
上面的操作對應的圖片是這樣的:

這樣作者就修改成你的名字了，更多的信息可以點擊本編輯窗口上面的insert varibles按鈕，會彈出一些文件名稱，項目名稱等參數，你可以選擇性地添加到你的注視中。

然後在你的類中，你只要敲入/**然後換行，注釋就自動滴添加到你的代碼中了~希望能幫上你的忙~^_^

追問：
這只是文檔前的版權聲明注釋，如果要在文檔中對代碼添加註釋，裡面帶上修改時間，如何弄
回答：
這樣弄哈~
1.開始還是打開Eclipse,然後點擊->windows->preferences->Java->code styles->code templates->comments

2.下一步選擇methods，而不是types。然後edit，insert varibles，添加上date變數，長下面這個樣子。

然後你在你的函數上面同樣是敲入/**回車，就出現了修改的日期了

補充：
對於那個行首出現注釋的問題是java的代碼風格的問題，可以這樣改
打開Eclipse,然後點擊->windows->preferences->Java->code styles->formatter
->edit->comment 的標簽頁->never indent line comments on first column
這樣，注釋的//就會縮進了，而不是頂在行首了~

❾ java 中的幾種注釋方式

我看動力節點的java基礎大全301集教中的三種注釋方法：

1、單行注釋 //注釋的內容

2、多行注釋/*......*/

3、/**......*/，這種方式和第二種方式相似。這種格式是為了便於javadoc程序自動生成文檔。

下面介紹一下Javadoc的標記：

特別聲明：

（1）javadoc針對public類生成注釋文檔

（2）javadoc只能在public、protected修飾的方法或者屬性之上

（3）javadoc注釋的格式化：前導*號和HTML標簽

（4）javadoc注釋要僅靠在類、屬性、方法之前

下面主要舉例說明第三種注釋的應用：

（1）首先編寫.java文件

（2）在命令行中執行以下dos命令：

javadoc *.java //根據相應的Java源代碼及其說明語句生成HTML文檔

//javadoc標記：是@開頭的，對javadoc而言，特殊的標記。

（3）在當前目錄下就會產生doc文件夾，裡面有一系列的.html文件

附上代碼：

[java]view plain

• <spanstyle="font-size:18px;">*/

• /**javadoc注釋的內容

• */

• publicclassHello{

• /**屬性上的注釋*/

• publicStringname;

• /**這是main方法,是程序的入口

• *@paramargs用戶輸入參數

• */

• publicstaticvoidmain(String[]args){

• System.out.println("HelloWorld!");

• f1();

• }

• /**這是第1個方法,其作用是...*/

• publicstaticvoidf1(){

• System.out.println("f1()！");

• }

• }</span>

[java]view plain

• <spanstyle="font-size:18px;">importjava.io.IOException;

• /**javadoc注釋內容

• *@since1.0

• *@version1.1

• *@authorBlueJey

• *<br>鏈接到另一個文檔{@linkHello},就這些

• *seeHello

• */

• publicclassHelloWorld{

• /**非public，protected屬性上的注釋不生成*/

• publicStringname;

• /**這是main方法，是程序的入口

• *@paramargs用戶輸入的參數，是數組

• *@throwsIOExceptionmain方法io異常

• */

• publicstaticvoidmain(Stringargs[])throwsIOException{

• System.out.println("helloWorld!");

• f1();

• f2(1);

• }

• /**這是第一個方法，其作用是....

• *@deprecated從版本1.2開始，不再建議使用此方法

• */

• publicstaticvoidf1(){

• System.out.println("fl()!");

• }

• /**這是第二個方法，其作用是....

• *@return返回是否OK

• *@parami輸入參數i

• *@seeHello

• *@throwsIOExceptionio異常

• */

• publicstaticStringf2(inti)throwsIOException{

• System.out.println("f1()!");

• return"OK";

• }

• }</span>

注意：

如果源文件中有用到@version,@author標記，則在執行javadoc命令時，要加-version-author

javadoc-version-author-ddoc*.java

（其中用-version用於提取源文件中的版本信息-author用於提取源文件中的作者信息）

❿ JAVA的注釋問題

兩種可能：
1.項目引用了別人的源碼，用這種方式可以表示尊重對方的版權，通常可能樓主也遇到過就是我們去一些別的博客或者站點看文章的時候，文章的開頭或者結尾都有一句提示說「如轉載，請註明文章來自於XXX」對吧，源碼也是如此，因為生成doc後這段注釋代碼會存在於doc中，這樣的話源碼的所有者只要源碼是開源的並且尊重了這種聲明協議，也就不會再追究責任了。
2.自己的項目頭，通常使用的一些團隊開發軟體比如cvs或者開發ide在你新建一個類的時候自動產生這段代碼，說明源碼的公司等信息。