android studio和 Eclipse中程式碼的註釋,讓你的程式碼更加
Android studio的註釋配置
Android Studio 按照下面的步奏配置:
Files-->Settings-->Editor-->File and Code Templates-->Includes
對類的註解
注意:上面的英文在studio必須是大寫
這樣在新建一個java類檔案的時候,就會將自動生成Class Header中的內容,自動新增了你的註釋模板中定義好了的註釋,顯示如下:
package contract.test.day01;
/**
* 專案名稱:Day01
* 類描述:
* 建立人:wy
* 建立時間:2014/12/24 11:17
* 修改人:wy
* 修改時間:2014/12/24 11:17
* 修改備註:
*/
public class KKs {
}
javadoc文件輸出註釋的快捷按鍵
File->Settings,搜尋keymap,點開Keymap,在右邊皮膚上搜尋,找到Other->Fix doc comment,雙擊,選擇Add Keyboard Shortcut,按下你的快捷鍵。Eclipse中是alt + shift +J,但是在這裡會衝突,所以我用了比較近的快捷鍵組合:alt + shift + K。在修改文件註釋,如新增引數等方面,Android Studio的快捷鍵比Eclipse要智慧多了。
選中你要修改快捷鍵的功能點,右鍵,就能彈出對話方塊了,對話方塊有4個選項,這裡解釋下4個選項:
Add Keyboard Shortcut:設定鍵盤快捷鍵
Add Mouse Shortcut:設定滑鼠快捷鍵,比如滑鼠左鍵,滑鼠右鍵
Add Abbreviation:這個是新增一個簡寫
最後一個就是移除快捷鍵了。
關於修改快捷鍵這裡還需要注意下:
比如我選了第一個,選中對話方塊,這個時候你要修改快捷鍵一定要注意,比如我要修改成Ctrl+Shift+Z,這個時候不是一個一個對應的按鍵按下去,你一定要把Ctrl,Shift,Z三個一起按下去,因為這邊只預設識別單次輸入。Add Mouse Shortcut也是類似的。
private void wy(int x, int y) { } }
把滑鼠放置在wy函式上面,按住你在Fix doc comment上面設定的快鍵按鍵,就會彈出註釋:
/**
* @param x
* @param y
*/
private void wy(int x, int y)
{
}
}
函式體的另一種註解:你如上面圖所示新建一個Method Header
在裡面加入下面程式碼:
/**
* 〈一句話功能簡述〉
* 〈功能詳細描述〉
* @param [引數1] [引數1說明]
* @param [引數2] [引數2說明]
* @return [返回型別說明]
* @exception/throws [違例型別] [違例說明]
* @see [類、類#方法、類#成員]
*/
* 〈一句話功能簡述〉
* 〈功能詳細描述〉
* @param [引數1] [引數1說明]
* @param [引數2] [引數2說明]
* @return [返回型別說明]
* @exception/throws [違例型別] [違例說明]
* @see [類、類#方法、類#成員]
*/
這樣對函式的描述更加強大
eclipse中新增程式碼註釋功能
例如:
/**
* @param
* @return
*/
快捷鍵為:ALT + SHIFT +J
想更換為其他的快捷鍵:
Window-->Preferences-->General-->Keys;找到"add javadoc comment"更改自己喜歡的快捷鍵。
另外如果覺得註釋也不爽時也可以改改,修改的方法有兩種:
1.直接在eclipse給的模板下進行修改
2.自己編寫一個xml文件匯入進去
那就來先說說第一種方法吧:
開啟eclipse
Window-->Preferences-->Java-->Code Style --> Code Templates --> Comments --> types --> Edit
/**
*
* 專案名稱:${project_name}
* 類名稱:${type_name}
* 類描述:
* 建立人:${user}
* 建立時間:${date} ${time}
* 修改人:${user}
* 修改時間:${date} ${time}
* 修改備註:
* @version
*
*/
第二種方法是:
點選右邊的import按鈕選擇你寫好的模板.xml檔案
下面是一個註釋行模板codetemplates.xml,可以直接匯入使用。貼出原始碼供大家參考一下
<?xml version="1.0" encoding="UTF-8"?>
<templates>
<template autoinsert="false"
context="constructorcomment_context"
deleted="false" description="Comment for created constructors"
enabled="true"
id="org.eclipse.jdt.ui.text.codetemplates.constructorcomment"
name="constructorcomment">
/**
* 建立一個新的例項 ${enclosing_type}.
*
* ${tags}
*/
</template>
<template autoinsert="true"
context="settercomment_context"
deleted="false"
description="Comment for setter method"
enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.settercomment"
name="settercomment">
/**
* @param ${param} the ${bare_field_name} to set
*/
</template>
<template autoinsert="false"
context="methodcomment_context"
deleted="false"
description="Comment for non-overriding methods"
enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.methodcomment"
name="methodcomment">
/**
* ${enclosing_method}(這裡用一句話描述這個方法的作用)
* TODO(這裡描述這個方法適用條件 – 可選)
* TODO(這裡描述這個方法的執行流程 – 可選)
* TODO(這裡描述這個方法的使用方法 – 可選)
* TODO(這裡描述這個方法的注意事項 – 可選)
* @param name
* @param @return 設定檔案
* @return String DOM物件
* @Exception 異常物件
* @since CodingExample Ver(編碼範例檢視) 1.1
*/
</template>
<template autoinsert="true"
context="delegatecomment_context"
deleted="false"
description="Comment for delegate methods"
enabled="true"
id="org.eclipse.jdt.ui.text.codetemplates.delegatecomment"
name="delegatecomment">
/**
* ${tags}
* ${see_to_target}
*/
</template>
<template autoinsert="false"
context="filecomment_context"
deleted="false"
description="Comment for created Java files"
enabled="true"
id="org.eclipse.jdt.ui.text.codetemplates.filecomment"
name="filecomment">
/**
* 檔名:${file_name}
*
* 版本資訊:
* 日期:${date}
* Copyright 足下 Corporation ${year}
* 版權所有
*
*/
</template>
<template autoinsert="false"
context="gettercomment_context"
deleted="false"
description="Comment for getter method"
enabled="true"
id="org.eclipse.jdt.ui.text.codetemplates.gettercomment"
name="gettercomment">
/**
* ${bare_field_name}
*
* @return the ${bare_field_name}
* @since CodingExample Ver(編碼範例檢視) 1.0
*/
</template>
<template autoinsert="true"
context="overridecomment_context"
deleted="false"
description="Comment for overriding methods"
enabled="true"
id="org.eclipse.jdt.ui.text.codetemplates.overridecomment"
name="overridecomment">
/**
* (non-Javadoc)
* ${see_to_overridden}
*/
</template>
<template autoinsert="false"
context="fieldcomment_context"
deleted="false"
description="Comment for fields"
enabled="true"
id="org.eclipse.jdt.ui.text.codetemplates.fieldcomment"
name="fieldcomment">
/**
* ${field}:${todo}(用一句話描述這個變數表示什麼)
*
* @since Ver 1.1
*/
</template>
<template autoinsert="false"
context="typecomment_context"
deleted="false"
description="Comment for created types"
enabled="true"
id="org.eclipse.jdt.ui.text.codetemplates.typecomment"
name="typecomment">
/**
*
* 專案名稱:${project_name}
* 類名稱:${type_name}
* 類描述:
* 建立人:${user}
* 建立時間:${date} ${time}
* 修改人:${user}
* 修改時間:${date} ${time}
* 修改備註:
* @version
*
*/</template>
</templates>
有的時候匯入會出現錯誤說無效的1位元組UTF-8格式,解決辦法,editplus開啟該xml檔案,另存為-選擇encoding為UTF-8-確定-覆蓋原檔案,重新執行,終於成功了
相關文章
- Android Annotation-讓你的程式碼和設計更加優雅(一)Android
- DSL-讓你的 Ruby 程式碼更加優雅
- 使用Spring的註釋和反射讓程式碼更精簡Spring反射
- 如何讓自己的程式碼更加安全?
- 想讓你的程式碼變得更加優雅嗎?
- 程式設計師是否有義務做好程式碼的註釋?你做好程式碼註釋了嗎?程式設計師
- 有趣的程式碼註釋
- Visual Studio模板程式碼註釋小技巧分享
- Oracle PL/SQL程式碼中的註釋OracleSQL
- Android Annotation-讓你的程式碼更加優雅(二)做一個Java詩人(JavaPoet)AndroidJava
- 程式碼才是最好的註釋
- 你寫註釋她幫你寫程式碼
- 聊一聊Java8 Optional,讓你的程式碼更加優雅Java
- async/await 是如何讓程式碼更加簡潔的?AI
- 你的 JS 程式碼本可以更加優雅JS
- 將 Visual Studio .net 程式碼註釋 英文轉為中文
- IDEA中修改程式碼中的註釋顏色Idea
- 如何把程式碼中的註釋批次刪除
- CSS程式碼註釋CSS
- 自定義Android Studio程式碼模板Android
- Android安全防護之旅---幾行程式碼讓Android應用變得更加安全Android行程
- Java11正式釋出了,讓你的程式碼更完美?Java
- 請停止程式碼註釋
- 作為程式設計師,有沒有讓你感到既無語又崩潰的程式碼註釋?程式設計師
- 全面吃透JAVA Stream流操作,讓程式碼更加的優雅Java
- Android Studio程式碼除錯技巧篇Android除錯
- android studio 除錯 framework 層程式碼Android除錯Framework
- Java事務註解:讓你的程式碼如絲般順滑Java
- IDEA外掛:快速刪除Java程式碼中的註釋IdeaJava
- 竟有如此沙雕的程式碼註釋!
- 如何快速讓你的程式碼支援Cocoapods!
- 如何讓你的程式碼整潔漂亮
- 解決Eclipse中文註釋部分亂碼的問題Eclipse
- HTML 程式碼註釋規範HTML
- html檔案中的php程式碼被註釋掉的問題HTMLPHP
- Android Studio 藍芽 示例程式碼(轉)Android藍芽
- 把Mybatis Generator生成的程式碼加上想要的註釋MyBatis
- 在程式碼註釋中,除了常見的 TODO、FIXME 和 XXX 外,還有哪些?
- jvm執行程式碼註釋部分JVM行程