溫馨提示×
您好，登錄后才能下訂單哦！
點擊 登錄注冊 即表示同意《億速云用戶服務條款》
您好，登錄后才能下訂單哦！
這篇文章給大家分享的是有關java中類文件注釋規約的示例分析的內容。小編覺得挺實用的，因此分享給大家做個參考，一起跟隨小編過來看看吧。
為了區分作者和版本的概念以及，開發請遵守下面設置。 如：現在項目大版本為1，創建類文件模板默認因為版本1。 作者名字為自己的名字，如需要在類里新增特性方法，需要在類作者上加入自己的名字。 修改小的bug不需要加入自己的名字。
設置里：Preferences | Editor | File and Code Templates cdn.nlark.com/yuque/0/2019/png/204430/1557802550824-25113b0e-236d-4934-b08d-61c84581f25d.png"> 點擊導航欄Includes->列表文件File Header 添加內容保存即可。
/** * @author <作者> * @since <版本> */
如下，創建類默認加入類注釋頭部。（請務必需要在注釋上標注該類的使用用途）
/**
* {@link RestController} Test測試Controller
*
* @author purgeyao
* @since 1.0
*/
@RestController
public class TestController {
@GetMapping("test")
public String test(){
return "123";
}
}如果你不是該類的創建者，要增加新的特性方法，需要在注釋頭部加入自己的author。 修改小的bug則不需要添加自己的author
/** * @author purgeyao * @author <自己的名字> * @since 1.0 */
版本請和當前項目版本大版本一致。（如：該項目為2.0版本，請在idea模板里將@since改為2.0） 項目大版本升級請更新@since版本，為了好區分類的作用以及處于項目那個版本創建。
/** * @author purgeyao * @since 2.0 */
感謝各位的閱讀！關于“java中類文件注釋規約的示例分析”這篇文章就分享到這里了，希望以上內容可以對大家有一定的幫助，讓大家可以學到更多知識，如果覺得文章不錯，可以把它分享出去讓更多的人看到吧！
免責聲明：本站發布的內容（圖片、視頻和文字）以原創、轉載和分享為主，文章觀點不代表本網站立場，如果涉及侵權請聯系站長郵箱：is@yisu.com進行舉報，并提供相關證據，一經查實，將立刻刪除涉嫌侵權內容。
