成人无码视频,亚洲精品久久久久av无码,午夜精品久久久久久毛片,亚洲 中文字幕 日韩 无码

資訊專(zhuān)欄INFORMATION COLUMN

類(lèi)文件注釋規(guī)約

VioletJack / 2052人閱讀

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

類(lèi)文件注釋規(guī)約 1.簡(jiǎn)介

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

2.idea模板設(shè)置

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

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

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

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

如下，創(chuàng)建類(lèi)默認(rèn)加入類(lèi)注釋頭部。（請(qǐng)務(wù)必需要在注釋上標(biāo)注該類(lèi)的使用用途）

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

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

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

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

版本請(qǐng)和當(dāng)前項(xiàng)目版本大版本一致。（如：該項(xiàng)目為2.0版本，請(qǐng)?jiān)趇dea模板里將@since改為2.0）
項(xiàng)目大版本升級(jí)請(qǐng)更新@since版本，為了好區(qū)分類(lèi)的作用以及處于項(xiàng)目那個(gè)版本創(chuàng)建。

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

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

轉(zhuǎn)載請(qǐng)注明本文地址：http://m.hztianpu.com/yun/76066.html

相關(guān)文章

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

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

    worldligang 評(píng)論0 收藏0

  • 常識(shí)之外的規(guī)范——阿里java開(kāi)發(fā)手冊(cè)筆記(全章節(jié))

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

    Martin91 評(píng)論0 收藏0

  • 第3章：抽象數(shù)據(jù)類(lèi)型（ADT）和面向?qū)ο缶幊蹋∣OP） 3.2設(shè)計(jì)規(guī)約

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

    mozillazg 評(píng)論0 收藏0

  • 阿里巴巴java開(kāi)發(fā)手冊(cè)學(xué)習(xí)記錄，php版

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

    wangym 評(píng)論0 收藏0

發(fā)表評(píng)論

0條評(píng)論

閱讀需要支付1元查看
<