IDEA liveTemplate生成JAVA Doc模板

最新推荐文章于 2024-09-26 14:17:53 发布
菜鸡03号
最新推荐文章于 2024-09-26 14:17:53 发布
阅读量3.4k
点赞数
分类专栏：项目配置管理
项目配置管理专栏收录该内容
24 篇文章 0 订阅
订阅专栏
 
 
  
  注释模版

  
  注释模版是指在编写代码时针对不同的类，方法或者其他文件时自动生成的注释信息。在eclipse我们很熟悉可以利用 /**,Enter在方法，类名等前一行来生成注释模板，但是IntelliJ IDEA并没有去按照原来的方法去实现。他引进了Live Template来达到类似效果。

  
  从eclipse到IDEA

  
  eclipse中的注释模板在code Template中,它存储的形式xml文件。

修改相关配置如下图：


    
    

     
     

      
      

      
       
        
      

     
     

     
     
      
      eclipse code template
     
     

    
    


模板样式如下:


  
  /**
* @Title: ${file_name}
* @Package ${package_name}
* @Description: TODO
* @author syncwt
* @date ${date} ${time}
* @version V1.0
*/

  
  配置好之后只需在方法，类名等前一行输入/**,Enter即可生成注释。
  
  IDEA中也有在文件头注释的模板。但仅限于类文件头和所有文件头。配置如下图：


    
    
     
     
      
      
      
       
        
      
     
     
     
     
      
      IDEA File and Code Template
     
     
    
    

这显然难以满足我们开发的需求,这时候就需要用Live Template
  
  Live Template
  
  介绍
  
  用中文应该叫做热加载模板。它的原理就是配置一些常用代码字母缩写，在输入简写时可以出现你预制的模板内容，使得开发效率大大提高。最简单的例子就是在Java中输入sout会出现System.out.println();如图所示：

  
  
   
   
    
    
    
    
     
     
    
    
   
   
   
   
    
    代码提示
   
   
  
  
  
  
同样，注解的模板配置也是采用这样的原理和形式来进行配置。
  
  
  
  配置
  
  我当前的版本是2017.1EAP,其他版本应该都差不多。
在配置当中找到Live Template,右边加号先添加一个TemplateGroup,选中该分组再点击加号添加一个Live Template.
Abbreviation中填写命令,Description填写描述,Template text填写你的配置模板。

  
  
   
   
    
    
    
    
     
     
    
    
   
   
   
   
    
    配置
   
   
  
  
  
  
模板配置的规则是这样子的：
  
  
变量名以
  
  $<variable_name>$的形式出现,调用的方法也是先以变量形式出现，写完模板信息后去编辑变量(Edit variables)
  
  

  
  
   
   
    
    
    
    
     
     
    
    
   
   
   
   
    
    编辑变量
   
   
  
  
  
  
找到相应的的方法对应变量名即可。方法名即功能描述表见附件。
  
  

  
  我这个版本有点坑，变量名的default值无法显示，所以我直接在Template text中写死了一些信息
  
  
  
  样例
  
  Abbreviation: cc
Description: class comment template

Template text:
/**
 * class_name: $CLASS_NAME$
 * package: $PACKAGE_NAME$
 * describe: TODO
 * creat_user: wanwt@senthinkcom
 * creat_date: $CREAT_DATE$
 * creat_time: $CREAT_TIME$
 **/

 Template variables:
 CLASS_NAME -> className()
 PACKAGE_NAME -> currentPackage()
 CREAT_DATE -> date()
 CREAT_TIME -> time()

  
  Abbreviation: mc
Description: method comment template

Template text:
/**
 * class_name: $METHOD_NAME$
 * param: $METHOD_PARAM$
 * describe: TODO
 * creat_user: wanwt@senthinkcom
 * creat_date: $CREAT_DATE$
 * creat_time: $CREAT_TIME$
 **/

 Template variables:
 METHOD_NAME -> methodName()
 METHOD_PARAM -> methodParameters()
 CREAT_DATE -> date()
 CREAT_TIME -> time()

  
  效果
  
  
   
   
    
    
    
    
     
     
    
    
   
   
   
   
    
    效果
   
   
  
  
  
  不足
  
  live template中的函数方法是读取当前函数体的属性，所以只有在该方法内使用该命令才能获取,类没有这个问题。
Template variables的Expression不能叠加方法。定制化程度不够好。
  
  附件
  
  Predefined functions to use in live template variables
  
  Item
Description
annotated("annotation qname")
Creates a symbol of type with an annotation that resides at the specified location. For an example, see Live Templates in the iterations group.
arrayVariable()
Suggests all array variables applicable in the current scope. For an example, see Live Templates in the iterations group.
anonymousSuper()
Suggests a supertype for a Kotlin object expression.
camelCase(String)
Returns the string passed as a parameter, converted to camel case. For example, my-text-file/my text file/my_text_file will be converted to myTextFile.
capitalize(String)
Capitalizes the first letter of the name passed as a parameter.
capitalizeAndUnderscore(sCamelCaseName)
Capitalizes the all letters of a CamelCase name passed as a parameter, and inserts an underscore between the parts. For example, if the string passed as a parameter is FooBar, then the function returns FOO_BAR.
castToLeftSideType()
Casts the right-side expression to the left-side expression type. It is used in the iterations group to have a single template for generating both raw-type and Generics Collections.
className(sClassName)
Returns the name of the current class (the class where the template is expanded).
classNameComplete()
This expression substitutes for the class name completion at the variable position.
clipboard()
Returns the contents of the system clipboard.
snakeCase(String)
Returns CamelCase string out of snake_case string. For example, if the string passed as a parameter is foo_bar, then the function returns fooBar.
complete()
This expression substitutes for the code completion invocation at the variable position.
completeSmart()
This expression substitutes for the smart type completion invocation at the variable position.
componentTypeOf (<array variable or array type>)
Returns component type of an array. For example, see the Live Templates in the iterations group in the other group.
currentPackage()
Returns the current package name.
date(sDate)
Returns the current system date in the specified format.
By default, the current date is returned in the default system format. However, if you specify date format in double quotes, the date will be presented in this format:

decapitalize(sName)
Replaces the first letter of the name passed as a parameter with the corresponding lowercase letter.
descendantClassEnum(<String>)
Shows the children of the class entered as a string parameter.
enum(sCompletionString1,sCompletionString2,...)
List of comma-delimited strings suggested for completion at the template invocation.
escapeString(sEscapeString)
Escapes the specified string.
expectedType()
Returns the type which is expected as a result of the whole template. Makes sense if the template is expanded in the right part of an assignment, after return, etc.
fileName(sFileName)
Returns file name with extension.
fileNameWithoutExtension()
Returns file name without extension.
firstWord(sFirstWord)
Returns the first word of the string passed as a parameter.
groovyScript("groovy code")
Returns Groovy script with the specified code.
You can use groovyScript macro with multiple arguments. The first argument is a script text that is executed or a path to the file that contains a script. The next arguments are bound to _1, _2, _3, ..._nvariables that are available inside your script. 
Also, _editor variable is available inside the script. This variable is bound to the current editor.
guessElementType (<container>)
Makes a guess on the type of elements stored in a java.util.Collection. To make a guess, IntelliJ IDEA tries to find the places where the elements were added to or extracted from the container.
iterableComponentType(<ArrayOrIterable>)
Returns the type of an iterable component, such as an array or a collection.
iterableVariable()
Returns the name of a variable that can be iterated.
lineNumber()
Returns the current line number.
lowercaseAndDash(String)
Returns lower case separated by dashes, of the string passed as a parameter. For example, the string MyExampleName is converted to my-example-name.
methodName()
Returns the name of the embracing method (where the template is expanded).
methodParameters()
Returns the list of parameters of the embracing method (where the template is expanded).
methodReturnType()
Returns the type of the value returned by the current method (the method within which the template is expanded).
qualifiedClassName()
Returns the fully qualified name of the current class (the class where the template is expanded).
Clear the Shorten FQ names check box.
rightSideType()
Declares the left-side variable with a type of the right-side expression. It is used in theiterations group to have a single template for generating both raw-type and Generics Collections.
snakeCase(sCamelCaseText)
Returns snake_case string out of CamelCase string passed as a parameter.
spaceSeparated(String)
Returns string separated with spaces out of CamelCase string passed as a parameter. For example, if the string passed as a parameter is fooBar, then the function returns foo bar.
subtypes(sType)
Returns the subtypes of the type passed as a parameter.
suggestIndexName()
Suggests the name of an index variable. Returns i if there is no such variable in scope, otherwise returns j if there is no such variable in scope, etc.
suggestVariableName()
Suggests the name for a variable based on the variable type and its initializer expression, according to your code style settings that refer to the variable naming rules.
For example, if it is a variable that holds an element within iteration, IntelliJ IDEA makes a guess on the most reasonable names, also taking into account the name of the container being iterated.
suggestFirstVariableName(sFirstVariableName)
Doesn't suggest true, false, this, super.
time(sSystemTime)
Returns the current system time.
typeOfVariable(VAR)
Returns the type of the variable passed as a parameter.
underscoresToCamelCase(sCamelCaseText)
Returns the string passed as a parameter with CamelHump letters substituting for underscores. For example, if the string passed as a parameter is foo_bar, then the function returns fooBar.
underscoresToSpaces(sParameterWithSpaces)
Returns the string passed as a parameter with spaces substituting for underscores.
user()
Returns the name of the current user.
variableOfType(<type>)
Suggests all variables that may be assigned to the type passed as a parameter, for example variableOfType("java.util.Vector"). If you pass an empty string ("") as a parameter, suggests all variables regardless of their types.
JsArrayVariable
Returns JavaScript array name.
jsClassName()
Returns the name of the current JavaScript class.
jsComponentType
Returns the JavaScript component type.
jsMethodName()
Returns the name of the current JavaScript method.
jsQualifiedClassName
Returns the complete name of the current JavaScript class.
jsSuggestIndexName
Returns a suggested name for an index.
jsSuggestVariableName
Returns a suggested name for a variable.
 
 


作者：syncwt
链接：http://www.jianshu.com/p/81b908da1fba
來源：简书
著作权归作者所有。商业转载请联系作者获得授权，非商业转载请注明出处。