国产xxxx99真实实拍_久久不雅视频_高清韩国a级特黄毛片_嗯老师别我我受不了了小说

資訊專欄INFORMATION COLUMN

類文件注釋規(guī)約

VioletJack / 2010人閱讀

摘要:類文件注釋規(guī)約簡介為了區(qū)分作者和版本的概念以及,開發(fā)請遵守下面設(shè)置。如現(xiàn)在項目大版本為,創(chuàng)建類文件模板默認因為版本。請務(wù)必需要在注釋上標注該類的使用用途測試作者如果你不是該類的創(chuàng)建者,要增加新的特性方法,需要在注釋頭部加入自己的。

類文件注釋規(guī)約 1.簡介

為了區(qū)分作者和版本的概念以及,開發(fā)請遵守下面設(shè)置。
如:現(xiàn)在項目大版本為1,創(chuàng)建類文件模板默認因為版本1。
作者名字為自己的名字,如需要在類里新增特性方法,需要在類作者上加入自己的名字。
修改小的bug不需要加入自己的名字。

2.idea模板設(shè)置

設(shè)置里:Preferences | Editor | File and Code Templates

點擊導(dǎo)航欄Includes->列表文件File Header
添加內(nèi)容保存即可。

/**
 * @author <作者>
 * @since <版本>
 */

3.模板內(nèi)容介紹

如下,創(chuàng)建類默認加入類注釋頭部。(請務(wù)必需要在注釋上標注該類的使用用途

/**
 * {@link RestController} Test測試Controller
 *
 * @author purgeyao
 * @since 1.0
 */
@RestController
public class TestController {

    @GetMapping("test")
    public String test(){
        return  "123";
    }
}
1).@author (作者)

如果你不是該類的創(chuàng)建者,要增加新的特性方法,需要在注釋頭部加入自己的author。
修改小的bug則不需要添加自己的author

/**
 * @author purgeyao
 * @author <自己的名字>
 * @since 1.0
 */
2).@since(版本)

版本請和當前項目版本大版本一致。(如:該項目為2.0版本,請在idea模板里將@since改為2.0)
項目大版本升級請更新@since版本,為了好區(qū)分類的作用以及處于項目那個版本創(chuàng)建。

/**
 * @author purgeyao
 * @since 2.0
 */

文章版權(quán)歸作者所有,未經(jīng)允許請勿轉(zhuǎn)載,若此文章存在違規(guī)行為,您可以聯(lián)系管理員刪除。

轉(zhuǎn)載請注明本文地址:http://specialneedsforspecialkids.com/yun/76066.html

相關(guān)文章

  • 阿里巴巴Java代碼規(guī)約插件p3c-pmd使用指南與實現(xiàn)解析

    摘要:年月底,阿里巴巴集團發(fā)布了阿里巴巴開發(fā)手冊終極版,年月日,在杭州云棲大會上,代碼規(guī)約插件全球首發(fā),插件支持以上版本和以上版本。阿里巴巴代碼規(guī)約插件安裝阿里代碼規(guī)約插件有插件和插件。 2017年9月底,阿里巴巴集團發(fā)布了《阿里巴巴Java開發(fā)手冊》PDF終極版,2017年10月14日,在2017杭州云棲大會上,Java代碼規(guī)約插件全球首發(fā),p3c-pmd插件支持Eclipse4.2以上版...

    worldligang 評論0 收藏0
  • 常識之外的規(guī)范——阿里java開發(fā)手冊筆記(全章節(jié))

    摘要:說明這篇文章是我第一次認真閱讀阿里巴巴開發(fā)手冊終極版的筆記。說明本手冊明確防止是調(diào)用者的責(zé)任。一年半載后,那么單元測試幾乎處于廢棄狀態(tài)。好的單元測試能夠最大限度地規(guī)避線上故障。 說明 這篇文章是我第一次(認真)閱讀《阿里巴巴 Java 開發(fā)手冊(終極版)》的筆記。手冊本身對規(guī)范的講解已經(jīng)非常詳細了,如果你已經(jīng)有一定的開發(fā)經(jīng)驗并且有良好的編碼習(xí)慣和意識,會發(fā)現(xiàn)大部分規(guī)范是符合常識的。所以...

    Martin91 評論0 收藏0
  • 第3章:抽象數(shù)據(jù)型(ADT)和面向?qū)ο缶幊蹋∣OP) 3.2設(shè)計規(guī)約

    摘要:程序失敗時,很難確定錯誤的位置。它保護客戶免受單位工作細節(jié)的影響。將前提條件放在中,并將后置條件放入和。涉及可變對象的契約現(xiàn)在取決于每個引用可變對象的每個人的良好行為。設(shè)計規(guī)約按規(guī)約分類比較規(guī)約它是如何確定性的。 大綱 1.編程語言中的功能/方法2.規(guī)約:便于交流的編程,為什么需要規(guī)約 行為等同規(guī)約結(jié)構(gòu):前提條件和后條件測試和驗證規(guī)約3.設(shè)計規(guī)約分類規(guī)約圖表規(guī)約質(zhì)量規(guī)約4.總結(jié) 編程...

    mozillazg 評論0 收藏0
  • 阿里巴巴java開發(fā)手冊學(xué)習(xí)記錄,php版

    摘要:的類型均為類型,前者現(xiàn)在時表示主動創(chuàng)建,后者過去分詞表示被動更新。推薦單表行數(shù)超過萬行或者單表容量超過,才推薦進行分庫分表。超過三個表禁止。防止因字段類型不同造成的隱式轉(zhuǎn)換,導(dǎo)致索引失效。說明會統(tǒng)計值為的行,而列名不會統(tǒng)計此列為值的行。 一.編程規(guī)約 (一)命名風(fēng)格 1.目錄使用小寫+下劃線 home,view,model,admin_view 2.類 UpperCamelCa...

    wangym 評論0 收藏0

發(fā)表評論

0條評論

VioletJack

|高級講師

TA的文章

閱讀更多
最新活動
閱讀需要支付1元查看
<