[巩固Java]代码注释

[巩固Java]代码注释

在 Java 中，有 2 种标记注释的方式。

• 最常用的方式是单行注释 //，其注释内容从 // 开始到本行结尾 快捷键：Ctrl+/
• 第二种是传统的 C 风格的注释，以 /* 开头，可以跨越多行，到 */ 结束。
• 一般大家都习惯在多行注释的每一行开头添加 *,快捷键:/*+回车

方法注释

在所在方法上一行插入方法注释，快捷键：/**+回车

例：

	/**
     *
     * @param categoryList
     * @param pageable
     * @return
     */
    public Page<Goods> getGoodsByCategoryIn(List<Category> categoryList, Pageable pageable);

自定义注释

步骤：（IDEA环境）

• File --> Editor --> Live Templates --> 点击右侧+号选择Template Group
• 新建一个任意命名的Template Group
• 在该自定义组下点击+号添加Live Template

图解：

Template text：

** 
* @Description: $description$ 
* @Param: $params$ 
* @return: $returns$ 
* @Author: zxg
* @Date: $date$ 
*/ 
// 注：之所以去掉首行的 / 是为了使变量内方法生效，所以在生成时多输入一个 /

示例：

// 在方法上一行输入/+a+tab生成
	/** 
    * @Description: 添加或更新一个商品 
    * @Param: [goods] 
    * @return: void 
    * @Author: zxg
    * @Date: 2021/4/21 
    */ 
    public void saveOrUpdateGoods(Goods goods){
        goodsDao.save(goods);
    }