在Mac版本下的IDEA中设置代码注释模版

在使用IDEA开发的过程中,我们可以通过设置代码注释模版,实现注释信息的自动补齐,提高编码效率。
我使用的是Mac电脑,就以Mac环境来进行说明吧。

在Mac上配置IDEA的代码注释模版,主要包括两个部分:一个是File Head文件头注释,用于描述类文件的信息;一个是方法头注释,用于描述类方法的信息。具体配置过程如下。

一、配置类文件头注释模版
点击IDEA编译器左上角的“IntelliJ IDEA”按钮,选择“Preferences...”,在弹出窗口中,选择“Editor-->File and Code Templates”,在窗口的右边“Schema”下拉栏选择“Default”,然后点击“Includes”标签,在右边模版栏中填写注释模版。最后点击右下角OK按钮生效。
参考内容如下:

/**
 * 项目名称:${PROJECT_NAME}
 * 类 名 称:${NAME}
 * 类 描 述:TODO
 * 创建时间:${DATE} ${TIME}
 * 创 建 人:${USER}
 */

其中${...}里填写的是自动填充内容的标签。窗口右下角有IDEA当前支持的标签列表。

二、配置方法头注释模版
点击IDEA编译器左上角的“IntelliJ IDEA”按钮,选择“Preferences...”,在弹出窗口中,选择“Editor-->Live Templates”,进入方法头注释模版编辑界面,如下图。

添加方法头的注释,需要有以下步骤:
(1)首先通过点击图中第二步中的“+”号,创建注释模版分组,比如我们命名为:MethodGroup;
(2)在第四步中的“Abbreviation”输入框中添加填充注释时需要输入的指令关键字,此处我们使用“add”作为关键字,并在第五步中添加指令说明。经过这个步骤后,指令关键字会出现在上一步创建的注释分组MethodGroup中,效果如图中的第三步;
(3)编辑注释内容模版,参考如下(注意:不需要以 /* 开头,因为需要我们在添加注释时会手动输入):

*
 * @name: $enclosing_method$
 * @description: TODO  $param$
 * @return: $return$
 * @date: $date$ $time$
 * @auther: $user$
 *
*/

(4)点击第七步按钮,在弹窗中指定注释代码里参数的取值方式。

需要注意的是,如果param参数默认系统的methodParam(),那么在注释语句中,将以 “@param: [pa1, pa2...]”形式展现。我们使用groovyScript脚本来设置param的注释语句格式,让每个参数占一行。
脚本内容为:

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

(5)接下来指定填充注释语句的提示字符,通过窗口中的“Expand with”来指定。"Space"表示空格,"Tab"表示 Tab键。
(6)最后是指定注释的使用范围,通过点击窗口下面的“...Change"来完成。

三、使用代码注释模版
上述操作完成后,就可以使用注释模版了。可以新建一个类,类文件头注释会自动生成。

在类中新建一个方法,然后在方法上面输入 /*add ,并按 Space键(空格键) ,就会自动补齐整段注释代码了。

原文地址:http://blog.51cto.com/andrewli/2349891

时间: 2024-07-31 01:32:02

在Mac版本下的IDEA中设置代码注释模版的相关文章

powerdesign 下ER模型中展示数据注释中文列

工作三年了,如果说对于数据库不敏感,我觉得的无论是作为一个前端开发人员还是后端开发人员来说,跟别人说你是个软件开发人员,我觉得都有点惭愧.可能之前一直在关注数据库sql的编写等等,但是现在我觉得有必要升华一下了,下面我就我遇到的问题,向大家提供一个解决方案,可能不是最好的,但是当实现了这个效果后,我真的眼前一亮,在此分享给大家...... 软件环境:powerdesign16.5 + win64(64位系统下,由于jdk的版本,powerdesign软件运行不正常,这个我安装jdk1.6_x86

Pycharm中设置快捷注释

给python设置快捷注释 1.打开pycharm软件,进入[文件]---[设置]--[文件和代码模板]--[Python Script] 2.编辑模板 代码如下: ##! usr/bin/python3 # -*- coding:utf-8 -*- # @Time: ${DATE} ${TIME} # @Author: shiguang # @Email: [email protected] # @File: ${NAME}.py 编辑完成,点击[确定]  3.新建python文件,查看效果

Windows环境下redis 配置文件中设置的密码无效

当我们安装了redis服务后,发现在其配置文件redis.windows.conf(或redis.conf)设置了密码:requirepass ****** 但是打开redis-cli.exe后输入命令config get requirepass发现: 这说明配置文件中密码设置后没有生效. 原因:问题在于我们启动redis服务时是直接在其安装目录中双击redis-server.exe启动的,这样启动的结果是,配置文件不会指定,此时redis并不会自动使用安装目录下的redis.windows.c

Mac 系统下cocos2dx 环境变量设置

Mac 系统环境变量设置 vim ~/.bash_profile export PATH=$PATH:/Users/wangchengcheng/Downloads/LearningSoftWare/Android/SDK/android-sdk-macosx/toolsexport PATH=$PATH:/Users/wangchengcheng/Downloads/LearningSoftWare/Android/SDK/android-sdk-macosx/platform-tools?e

MAC OS下锁屏快捷键设置

首先在应用程序中找到Automator打开,选择文稿类型为服务,点击选取.步骤如下图: 在搜索中输入run,双击Run Shell Script,如下图: 将服务收到选定的从文本选为没有输入,并在Shell脚本框中输入: '/System/Library/CoreServices/Menu Extras/User.menu/Contents/Resources/CGSession' -suspend 展示如下图: 在顶部菜单栏中文件-->存储,命名为Lock Screen,点击存储,如下图: 然

mac os下得pycharm怎么设置mercurial?

捣鼓了一会儿,最终搞定了. 先把链接贴上来:https://www.jetbrains.com/pycharm/help/mercurial.html 如果你发现你的pycharm在设置mercurial时是这样: 提示找不到hg,怎么办呢?从官网上的话来看,如果你跟我一样是默认安装的话设置成这样就好啦 或者试试另一个/opt/local/bin/hg If you followed the standard installation procedure, the default locatio

MyEclipse中设置代码块快捷键

如果想用快捷键生成一段自定义代码,可以通过下面方式设置: Java->Editor->Templates->New 如果要设置或者更改某个快捷键,如要设置保存全部文档的快捷键(系统默认为Ctrl+Shift+S): General->Keys 找到对应的快捷键,然后在绑定中输入:

ios开发xcode中设置代码块

在开发中有很多重复的代码,很多开发者把常用的代码做成代码块提高开发效率. 在xcode里选中代码块的时候总是很不容易,点击选中的代码(文字),不要移动和松开鼠标左键,当竖线变成像拉长了的x(我也不知道怎么形容)之后就可以拖动了,其实不需要多少时间,基本上就是:不要直接点鼠标左键就滑动鼠标,而是要下再拖动就可以了. 以后再使用这个代码就可以直接从里面拖出来就可以了 还可以自定义代码块的名称,使用范围,快捷键等

eclipse code templates 设置(eclipse注释模版配置)

文件(Files)注释标签:/** * @Title: ${file_name} * @Package ${package_name} * @Description: ${todo} * Copyright: Copyright (c) 2011  * Company:成都康赛电子科大信息技术有限责任公司 *  * @author Comsys-${user} * @date ${date} ${time} * @version V1.0 */ 类型(Types)注释标签(类的注释):/**