78545095###;
Set File header
Class Comment
/** * * @ProjectName: ${project_name} * @Package: ${package_name} * @ClassName: ${name} * @Description: Java class function Description * @Author: Tang Dynasty * @CreateDate: ${date} ${time} * @UpdateUser: Updater * @UpdateDate: ${date} ${time} * @UpdateRemark: Update description * @Version: 1.0 */ 2. Configuration method Generate comments by short name
CMT is a quick way to generate the main method for fast generation, similar to the MyEclipse main return.
/** * *@ProjectName:$PROJECT _name$ *@Package:$PACKAGE _name$ *@ClassName:$NAME$ * @Description : Java class function Description * @ Author @CreateDate $DATE $ $TIME $ * @UpdateUser : Updater * @UpdateDate $DATE $ $TIME $ * @UpdateRemark : Update content * @Version : 1.0 */
The role of MCMT is similar to CMT, and it is important to note that the generated comment is entered in the Java method inside the "MCMT" carriage return.
@method $methodName$ * @description 描述一下方法的作用 * @date: $date$ $time$ * @author: 唐朝 * @param $param$ * @return $return$ */
Groovyscript script, the params configuration above
Groovyscript ("Def result="; def params=\ "${_1}\". ReplaceAll ('[\ \\ \ \[| \\\\]| \\\s] ', '). Split (', '). ToList (); for (i = 0; i < params.size (); i++) {result+= ' * @param ' + params [i] + ((I < Params.size ()-1)? '\\n\\b ': ')}; return result ", Methodparameters ())
First, class comments
/**
*
* @ProjectName: ${project_name}
* @Package: ${package_name}
* @ClassName: ${name}
* @Description: Java class function description
* @Author: Tang Dynasty
* @CreateDate: ${date} ${time}
* @UpdateUser: Updated by
* @UpdateDate: ${date} ${time}
* @UpdateRemark: Update instructions
* @Version: 1.0
*/
Second, Method notes
/**
* @method $methodName $
* @description describe the role of the method
* @date: $date $ $time $
* @author: Tang Dynasty
* @param $param $
* @return $return $
*/
+++++++++++
Eclipse Java Comment Template setup
Set the entry for the comment template: Window->preference->java->code style->code Template and expand the Comments node is all the elements that need to be annotated
/**
* @Title: ${file_name}
* @Package ${package_name}
* @Description: ${todo} (describe what the file does in a word)
* @author a18ccms a18ccms_gmail_com
* @date ${date} ${time}
* @version V1.0
*/
Type (Types) Comment Label (note for Class):
/**
* @ClassName: ${type_name}
* @Description: ${todo} (here is a word describing the role of this class)
* @author A18ccms a18ccms_gmail_com
* @date ${date} ${time}
*
* ${tags}
*/
Field Comment Label:
/**
* @Fields ${field}: ${todo} (describe what this variable means in a sentence)
*/
Constructor Tags:
/**
* <p>title: </p>
* <p>description: </p>
* ${tags}
*/
Methods (Constructor & Methods) Tags:
/**
* @Title: ${enclosing_method}
* @Description: ${todo} (here is a word describing the effect of this method)
* @param ${tags} settings file
* @return ${return_type} return type
* @throws
*/
Override method (overriding Methods) Label:
/* (non-Javadoc)
* <p>title: ${enclosing_method}</p>
* <p>description: </p>
* ${tags}
* ${see_to_overridden}
*/
Delegate method (Delegate Methods) Label:
/**
* ${tags}
* ${see_to_target}
*/
Getter Method Tags:
/**
* @return ${bare_field_name}
*/
Setter Method Tags:
/**
* @param ${param} to set the ${bare_field_name}
*/
Android Studio Add file comment header template?