java注釋排版,java注釋寫法

本文目錄一覽：

• 1、java注釋若干行的格式
• 2、java方法名前注釋問題
• 3、java 文檔注釋是注釋什麼的,不是有多行注釋了嗎?
• 4、做java軟體工程師，怎樣才能寫出好的代碼？
• 5、JAVA 怎麼快捷多行注釋？

java注釋若干行的格式

注釋：//表示注釋一行。

/*表示注釋段內容（可以為很多行）*/

public static void main(String [] args){

System.out.println(“Hello World1”);

//System.out.println(“Hello World2”);

System.out.println(“Hello World3”);

/*System.out.println(“Hello World4”);

System.out.println(“Hello World5”);/*

}

這樣的話就只會輸出：

Hello World 1

Hello World 3

這樣很好理解吧？

java方法名前注釋問題

Java註解是附加在代碼中的一些元信息，用於一些工具在編譯、運行時進行解析和使用，起到說明、配置的功能。

註解不會也不能影響代碼的實際邏輯，僅僅起到輔助性的作用。包含在 java.lang.annotation 包中。

1、元註解

元註解是指註解的註解。包括 @Retention @Target @Document @Inherited四種。

1.1、@Retention: 定義註解的保留策略

@Retention(RetentionPolicy.SOURCE) //註解僅存在於源碼中，在class位元組碼文件中不包含

@Retention(RetentionPolicy.CLASS) // 默認的保留策略，註解會在class位元組碼文件中存在，但運行時無法獲得，

@Retention(RetentionPolicy.RUNTIME) // 註解會在class位元組碼文件中存在，在運行時可以通過反射獲取到

1.2、@Target：定義註解的作用目標

@Target(ElementType.TYPE) //介面、類、枚舉、註解

@Target(ElementType.FIELD) //欄位、枚舉的常量

@Target(ElementType.METHOD) //方法

@Target(ElementType.PARAMETER) //方法參數

@Target(ElementType.CONSTRUCTOR) //構造函數

@Target(ElementType.LOCAL_VARIABLE)//局部變數

@Target(ElementType.ANNOTATION_TYPE)//註解

@Target(ElementType.PACKAGE) ///包

由以上的源碼可以知道，他的elementType 可以有多個，一個註解可以為類的，方法的，欄位的等等

1.3、@Document：說明該註解將被包含在javadoc中。

1.4、@Inherited：說明子類可以繼承父類中的該註解。

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

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

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

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

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

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

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

擴展資料

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注釋

做java軟體工程師，怎樣才能寫出好的代碼？

Java代碼之於java程序員而言就是左膀右臂，java代碼寫的好的java程序員明顯更是企業的歡迎，一個優秀的java程序員的考核標準之一也是看他的編程水平。

其實有的java程序員java代碼會受到大家的追捧，是因為他在寫代碼時注意的細節往往多於那些不怎麼關注java代碼編程細節的程序員，俗話說：「細節決定成敗」，那麼如何寫出好的java代碼呢？IT培訓介紹一起來討論下：

1.重視注釋

有的java程序員在寫代碼時，從來沒有想過要在java代碼後加上相關的注釋，甚至是上萬行的代碼也沒有想過加上注釋，這就存在很大的問題，不說你的代碼會跟其他人分享討論，就你自己回顧你是怎麼寫好這篇代碼的，你也是半天無法理出頭緒，這就為維護和修改等等工作添加了很大的麻煩。所以，要想寫出好的java代碼，一定從簡短的java代碼編寫開始注重在java代碼後面加上相應的注釋，養成良好的習慣。

2.重視排版整潔

看很多java程序員的排版總覺得在欣賞一幅藝術品，但是看到一些java程序員的排版卻總覺得無力吐槽。同樣是編寫代碼，但是給人的視覺體驗是相當的不同，當然好的java代碼給人的享受也是美的，所以要想寫出好的代碼，一定要重視排版整潔。

3.注重命名規則

現在在一個團隊開發中，都會提前定製一個統一的命名規則，這樣利於提高工作效益。但是很多java程序員是缺乏這個意識的，每次敲代碼，更喜歡按照自己慣常的方式老命名模塊、函數，這樣是方便了自己，但是忽視團隊協作，所以在日常工作中，特別是團隊工作中一定要重視命名規則。

4.養成備份習慣

備份的重要性不用小編強調，相必你也知道。但是有的java程序員就是沒有養成這樣的好習慣，每次敲完代碼就不記得隨手保存，每次等到除了事故，比如電腦出了故障，辛辛苦苦敲打的java代碼沒保存找不回來的情況下就開始懊惱，與其這樣還不如在一開始就養成良好的備份習慣，這樣也方便自己日後查找利用。

JAVA 怎麼快捷多行注釋？

注釋   ：    分為多行注釋   單行注釋

//第一種情況就是滑鼠點擊這個一行 （如圖所示）         Ctrl +  /  就OK

//單行注釋

效果：

//或者是選中

//效果

//第二種情況就是多行注釋   選中要注釋的部分（如圖所示）  Ctrl+Shift +/

效果：

//第三種情況多行注釋   選中要注釋的部分（如圖所示）  Ctrl +/