1. 程式人生 > >JAVA 註釋模板-開發規範

JAVA 註釋模板-開發規範

新建:codetemplates.xml

複製一下內容:配置到eclipse裡面:

<?xml version="1.0" encoding="UTF-8" standalone="no"?>
<templates>
<template autoinsert="false" context="overridecomment_context" deleted="false" description="Comment for overriding methods" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.overridecomment" name="overridecomment">
/**
 * @描述:
 * @方法名: ${enclosing_method}
 * ${tags}
 * @建立人:${user}
 * @建立時間:${date}${time}
 * @修改人:${user}
 * @修改時間:${date}${time}
 * @修改備註:
 * @throws
 */
</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}
 * ${tags}
 * @返回型別 ${return_type}
 * @建立人 ${user}
 * @建立時間 ${date}${time}
 * @修改人 ${user}
 * @修改時間 ${date}${time}
 * @修改備註
 * @since
 * @throws
 */
</template>
<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">
/**
 * Title:
 * Description:
 * ${tags}
 */
</template>
<template autoinsert="false" context="settercomment_context" deleted="false" description="Comment for setter method" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.settercomment" name="settercomment">
/**
 * @param ${param} ${bare_field_name}
 */
</template>
<template autoinsert="false" 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="gettercomment_context" deleted="false" description="Comment for getter method" enabled="true" id="org.eclipse.jdt.ui.text.codetemplates.gettercomment" name="gettercomment">
/**
 * @return ${bare_field_name}
 */
</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}
 * @包名: ${package_name}
 * @類名稱:${type_name}
 * @建立人:${user}
 * @建立時間:${date}${time}
 * @修改人:${user}
 * @修改時間:${date}${time}
 * @修改備註:
 * @version v1.0
 * @see 
 * @bug 
 * @Copyright 
 * @mail *@qq.com
 */
</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}
 * @包名: ${package_name}
 * @功能描述:${todo}
 * @作者: ${user}
 * @建立時間: ${date} ${time}
 * @version v1.0
 */
</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}
 * @功能描述:
 * @建立人:${user}
 * @建立時間:${date}${time}
 */
</template>
</templates>

相關推薦

JAVA 註釋模板-開發規範

新建:codetemplates.xml 複製一下內容:配置到eclipse裡面: <?xml version="1.0" encoding="UTF-8" standalone="no"?> <templates> <template a

Eclipse Java註釋模板設置詳解

comment ons gmail const mail pack led dcom time 設置註釋模板的入口: Window->Preference->Java->Code Style->Code Template 然後展開Comments節點

IDEAL葵花寶典:java代碼開發規範插件 FindBugs-IDEA

finall rem width find 是否為空 col cnblogs input -s 前言:   檢測代碼中可能的bug及不規範的位置,檢測的模式相比p3c更多,寫完代碼後檢測下 避免低級bug,強烈建議用一下,一不小心就發現很多老代碼的bug。 使用步驟: 1

IDEAL葵花寶典:java代碼開發規範插件 lombok 插件

其中 wid alt www. 新建 實習 oar idt null 前言: lombok簡介:   lombok是暑假來到公司實習的時候發現的一個非常好用的小工具,剛見到的時候就感覺非常驚艷,有一種相見恨晚的感覺,用了一段時間之後感覺的確挺不錯,所以特此來推薦一下。   

IDEAL葵花寶典:java代碼開發規範插件 Rainbow Brackets 插件

height image ima 推薦 若有 大括號 ack line inf 前言:   最近在Jetbrains IDEA插件網站逛發現了 Rainbow Brackets這款插件,非常棒,推薦給大家。   可以實現配對括號相同顏色,並且實現選中區域代碼高亮的功能。  

Eclipse Java註釋模板設定詳解

出於對作者的尊重和感謝,原文地址為http://blog.csdn.net/ahhsxy/article/details/4542682 設定註釋模板的入口: Window->Preference->Java->Code Style->Co

Eclipse Java註釋模板設定詳解 快捷鍵:Shift+Alt+J

設定註釋模板的入口: Window->Preference->Java->Code Style->Code Template 然後展開Comments節點就是所有需設定註釋的元素啦。現就每一個元素逐一介紹: 檔案(Files)註釋標籤: /**  

Java開發利器:eclipse Java EE Linux、Mac、Win下載、安裝、配置、美化、註釋模板

點選紅框中的按鈕,接受許可協議,下載對應版本,Linux注意壓縮包字尾 程式開發使用8u191類似奇數為BUG修正並全部通過檢驗的版本,官方強烈推薦使用 偶數版本類似8u192包含了奇數版本所有的內容,以及未被驗證的BUG修復。Oracle官方表示:除非你深受BUG困

程式碼註釋規範-IDEA 配置 Java 類方法註釋模板

1. 引言     團隊開發時,業務模組分配的越清晰,程式碼註釋管理越完善,越有利於後面維護,後面再管理也方便不少。另外也起著"文字磚"的作用,你懂的。註釋不需要很詳細,把程式碼塊方法塊功能簡述一下就行。不然三月後回頭看就要罵人了,罵完發現是自己寫的,嘖嘖嘖...     三種常用的 Ja

談談Google與微信H5牛牛的Java開發規範

基本類 cli 多好 而且 spring final關鍵字 永久 zab rop 多年前,Google發布微信H5牛牛搭建平臺(h5.fanshubbs.com)來定義Java編碼時應遵循的微信牛牛Q_1687054422規範;今年年初阿裏則發布阿裏巴巴Java 開發手冊,

阿裏java開發規範學習(附P3C IDEA插件 幫助規範的養成)

插入 數據類型 修飾符 序列化 boolean ima tab 設計 布爾 淺析 阿裏巴巴 Java 開發規約 (未完成) contents 編程規約 編程規約 命名規約 OOP規約 命名規約 采用空格縮進,禁止使用tab字符。 這是G

eclipse安裝阿裏巴巴java開發規範插件

好代碼 als -o rri 面板 遇到 這樣的 困難 常量 阿裏巴巴java開發規範插件 作為JAVA開發人員,始終沒有一個明確的規範,何為好代碼,何為壞代碼,造成不同人的代碼風格不同,接手別人代碼後改造起來相當困難。前不久,阿裏巴巴發布了《阿裏巴巴Java開發手冊》得到

Java 枚舉(enum) 的常見用法和開發規範

blank index 不重復 light return sin ret lan ood JDK1.5引入了新的類型——枚舉。在 Java 中它雖然算個“小”功能,卻給我的開發帶來了“大”方便。 用法一:常量 在JDK1.5 之前,我們定義常量都是: public stat

Java開發規範最新詳盡版下載

1、開發規範的必要性           軟體開發需要規範,規範利於前期開發、團隊開發、後期迭代開發,最大限度的提高開發效率,降低開發成本,防範開發風險。JAVA開發規範一般包括程式設計規範、異常

JAVA註釋和變數命名規範

Java註釋 單行註釋://內容 多行註釋:/* 內容 */ 文件註釋:/** 內容 */ 命名 駝峰命名法 小駝峰:用於方法名,普通變數名稱 若識別符號是由單個單片語成,則全小寫。eg:int age = 10; 若識別符號是由多個單片語成,則第一個單詞小寫

Android開發規範Java命名規範

文章目錄 類名 方法名 變數名 類名 採用大駝峰命名法。 命名規則:功能+型別(Activity、Adapter、Service等)。 舉例: activity類,命名以Activity為字尾

IDEAL葵花寶典:java程式碼開發規範外掛 FindBugs-IDEA

 前言: 檢測程式碼中可能的bug及不規範的位置,檢測的模式相比p3c更多,寫完程式碼後檢測下 避免低階bug,強烈建議用一下,一不小心就發現很多老程式碼的bug。 使用步驟: 1):開啟 Settings---->Plugins---> 進行搜尋--->選擇---->"FindBug

IDEAL葵花寶典:java程式碼開發規範外掛 checkstyle、visualVM、PMD 外掛

前言: visualVM: 執行java程式的時候啟動visualvm,方便檢視jvm的情況 比如堆記憶體大小的分配;某個物件佔用了多大的記憶體,jvm調優必備工具。 checkstyle: CheckStyle是SourceForge下的一個專案,提供了一個幫助JAVA開發人員遵守某些編碼規範的工具。   

java註釋規範

很多java初學者不善於書寫註釋或者根本不寫註釋,這樣大大降低了程式碼的可讀性。在團隊開發的時候,不寫註釋是大忌,會大大降低開發效率。然而,註釋的書寫也有講究,可不僅僅是//和/**/這麼簡單,下面我們來看一下注釋的規範。 在為具體程式碼編寫註釋的同時,我們應該為下面的幾種情況新增文件註

java建站系統之無聊建站系統前端模板開發介面

無聊建站系統前端模板開發介面 使用無聊建站系統,前端開發者可自主定製開發實現多風格網站,實現起來高效、簡單、方便! 一、開發要求: 1、熟悉FreeMarker模板引擎的基本標籤使用 2、熟悉js/css,熟悉jquery等js框架 二、頁面型別 無聊建站系統,前端總共有以下6個頁面 1、首頁