IDEA的方法和类注释模板存档

本文档详细介绍了E2P开源系统中一个方法的实现,涉及参数解析和GroovyScript的使用,展示了如何在Java代码中创建规范化的注释,包括作用、参数和返回值的描述。

摘要生成于 C知道 ,由 DeepSeek-R1 满血版支持, 前往体验 >

方法

**
 * @author $user$
 * @date $date$ $params$
 * @return
 * <p>       
 * 该方法的作用:
 * $END$
 * </p>       
 */

参数对应分别如下:

groovyScript("def result=\"\"; def params=\"${_1}\".replaceAll('[\\\\[|\\\\]|\\\\s]', '').split(\",\").toList();   if(params.size()>0){  for(i = 0; i < params.size(); i++) { if(params[i]){  result+='\\n'+'* @param  ' + params[i];  } }; }; return result", methodParameters())

类上的注释信息:

/**
 *******************************************************************************
 *    系统名称   : E2P开源系统
 *    客户      :  E2P
 *    文件名    : ${PACKAGE_NAME}.${NAME}.java
 *              (C) Copyright ${YEAR} PonyWang Corporation
 *               All Rights Reserved.
 * *****************************************************************************
 * <PRE>
 * 作用
 *       ${description}
 * 限制
 *       无。
 * 注意事项
 *       无。
 * 修改历史
 * -----------------------------------------------------------------------------
 *         VERSION       DATE            BY       CHANGE/COMMENT
 * -----------------------------------------------------------------------------
 *         1.0.0        ${DATE}          PonyWang         create
 * -----------------------------------------------------------------------------
 * </PRE>
 **/
IntelliJ IDEA 中,为了提高代码文档化效率,你可以自定义类方法的注释模板。这样每次创建新类或方法时,只需填写少量内容,IDEA就会自动填充完整的注释。以下是设置注释模板的基本步骤: 1. 打开 IntelliJ IDEA,选择 "File" -> "Settings" (Windows/Linux) 或 "IntelliJ IDEA" -> "Preferences" (macOS)。 2. 寻找并点击 "Editor",然后选择 "Code Style" -> "Live Templates"。 3. 在左侧栏中找到 "General", "JavaDoc" 或者更具体的语言区域(如 "Java"),展开它。 4. 双击 "Code Folders" 来编辑现有模板,或者点击 "+" 创建新的模板。例如,为类方法分别设置模板,可以创建两个模板,如 "Class Comment" "Method Comment"。 5. 编辑模板内容。对于 `@param`、`@return` 等部分,可以用 `${...}` 标记表示需要用户输入的部分。例如,一个简单的类注释模板可能如下: ``` /** * ${CLASS_NAME} - 描述类的功能 * * ${DESCRIPTION} */ ``` 6. 对于方法模板,可能会包含输入参数名类型的提示: ``` /** * ${METHOD_NAME}(参数列表) * - 描述方法的作用 * * @param 参数1_name ${PARAM1_TYPE} 参数1描述 * @param 参数2_name ${PARAM2_TYPE} 参数2描述 * ... * @return 返回值类型 返回值描述 */ ``` 7. 设置完成后,记得保存更改。现在当你创建新的类或方法时,输入相应的触发短语(比如 "class" 或者 "method"),然后按回车键,IDEA 就会基于你的模板生成注释了。
评论 1
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值