/ **
* @ Title: $ {file_name}
* @ Package $ {package_name}
* @ Description: $ {todo} (one sentence description of what the document)
* @ Author A18ccms A18ccms_gmail_com
* @ Date $ {date} $ {time}
* @ Version V1.0
* /
Types (Types) Note label (class notes):
/ **
* @ ClassName: $ {type_name}
* @ Description: $ {todo} (here, one sentence description of the role of this class)
* @ Author A18ccms a18ccms_gmail_com
* @ Date $ {date} $ {time}
*
* $ {Tags}
* /
Field (Fields) comment tags:
/ **
* @ Fields $ {field}: $ {todo} (in one sentence that describes what the variable)
* /
Constructor Tags:
/ **
* <p> Title: </ p>
* <p> Description: </ p>
* $ {Tags}
* /
Methods (Constructor & Methods) Tags:
/ **
* @ Title: $ {enclosing_method}
* @ Description: $ {todo} (here, one sentence description of the role of this method)
* @ Param $ {tags} configuration files
* @ Return $ {return_type} return type
* @ Throws
* /
Override method (Overriding Methods) Tags:
/ * (Non-Javadoc)
* <p> Title: $ {enclosing_method} </ p>
* <p> Description: </ p>
* $ {Tags}
* $ {See_to_overridden}
* /
Representative methods (Delegate Methods) Tags:
/ **
* $ {Tags}
* $ {See_to_target}
* /
getter method Tags:
/ **
* @ Return $ {bare_field_name}
* /
setter method Tags:
/ **
* @ Param $ {param} to set the $ {bare_field_name}
* /
Example:
<? Xml version = "1.0" encoding = "UTF-8"?>
<templates>
<Template
autoinsert = "false"
context = "constructorcomment_context"
deleted = "false"
description = "Comment for created constructors"
enabled = "true"
name = "constructorcomment">
/ **
* Create a new instance of $ {enclosing_type}.
*
* $ {Tags}
* /
</ Template>
<Template
autoinsert = "true"
context = "settercomment_context"
deleted = "false"
description = "Comment for setter method"
enabled = "true"
name = "settercomment">
/ **
* @ Param $ {param} the $ {bare_field_name} to set
* /
</ Template>
<Template
autoinsert = "false"
context = "methodcomment_context"
deleted = "false"
description = "Comment for non-overriding methods"
enabled = "true"
name = "methodcomment">
/ **
* This method is described:
* @ Author: wangxiongdx@163.com
* @ Version: $ {date} $ {time}
* /
</ Template>
<Template
autoinsert = "true"
context = "delegatecomment_context"
deleted = "false"
description = "Comment for delegate methods"
enabled = "true"
name = "delegatecomment">
/ **
* $ {Tags}
* $ {See_to_target}
* /
</ Template>
<Template
autoinsert = "false"
context = "filecomment_context"
deleted = "false"
description = "Comment for created Java files"
enabled = "true"
name = "filecomment">
/ **
* File Name: $ {file_name}
*
* Version information:
* Date: $ {date}
* Copyright first step Corporation $ {year}
* All rights reserved
*
* /
</ Template>
<Template
autoinsert = "false"
context = "gettercomment_context"
deleted = "false"
description = "Comment for getter method"
enabled = "true"
name = "gettercomment">
/ **
* $ {Bare_field_name}
*
* @ Return the $ {bare_field_name}
* @ Since CodingExample Ver (See example code) 1.0
* /
</ Template>
<Template
autoinsert = "true"
context = "overridecomment_context"
deleted = "false"
description = "Comment for overriding methods"
enabled = "true"
name = "overridecomment">
/ * (Non-Javadoc)
* $ {See_to_overridden}
* /
</ Template>
<Template
autoinsert = "false"
context = "fieldcomment_context"
deleted = "false"
description = "Comment for fields"
enabled = "true"
name = "fieldcomment">
/ **
* $ {Field}: $ {todo} (in one sentence that describes what the variable)
*
* @ Since Ver 1.1
* /
</ Template>
<Template
autoinsert = "false"
context = "typecomment_context"
deleted = "false"
description = "Comment for created types"
enabled = "true"
name = "typecomment">
/ **
* Such a description is:
* @ Author: wangxiongdx@163.com
* @ Version: $ {date} $ {time}
* /
</ Template>
</ Templates>
<? Xml version = "1.0" encoding = "UTF-8"?>
<templates>
<Template
autoinsert = "false"
context = "constructorcomment_context"
deleted = "false"
description = "Comment for created constructors"
enabled = "true"
name = "constructorcomment">
/ **
* Create a new instance of $ {enclosing_type}.
*
* $ {Tags}
* /
</ Template>
<Template
autoinsert = "true"
context = "settercomment_context"
deleted = "false"
description = "Comment for setter method"
enabled = "true"
name = "settercomment">
/ **
* @ Param $ {param} the $ {bare_field_name} to set
* /
</ Template>
<Template
autoinsert = "false"
context = "methodcomment_context"
deleted = "false"
description = "Comment for non-overriding methods"
enabled = "true"
name = "methodcomment">
/ **
* This method is described:
* @ Author: wangxiongdx@163.com
* @ Version: $ {date} $ {time}
* /
</ Template>
<Template
autoinsert = "true"
context = "delegatecomment_context"
deleted = "false"
description = "Comment for delegate methods"
enabled = "true"
name = "delegatecomment">
/ **
* $ {Tags}
* $ {See_to_target}
* /
</ Template>
<Template
autoinsert = "false"
context = "filecomment_context"
deleted = "false"
description = "Comment for created Java files"
enabled = "true"
name = "filecomment">
/ **
* File Name: $ {file_name}
*
* Version information:
* Date: $ {date}
* Copyright first step Corporation $ {year}
* All rights reserved
*
* /
</ Template>
<Template
autoinsert = "false"
context = "gettercomment_context"
deleted = "false"
description = "Comment for getter method"
enabled = "true"
name = "gettercomment">
/ **
* $ {Bare_field_name}
*
* @ Return the $ {bare_field_name}
* @ Since CodingExample Ver (See example code) 1.0
* /
</ Template>
<Template
autoinsert = "true"
context = "overridecomment_context"
deleted = "false"
description = "Comment for overriding methods"
enabled = "true"
name = "overridecomment">
/ * (Non-Javadoc)
* $ {See_to_overridden}
* /
</ Template>
<Template
autoinsert = "false"
context = "fieldcomment_context"
deleted = "false"
description = "Comment for fields"
enabled = "true"
name = "fieldcomment">
/ **
* $ {Field}: $ {todo} (in one sentence that describes what the variable)
*
* @ Since Ver 1.1
* /
</ Template>
<Template
autoinsert = "false"
context = "typecomment_context"
deleted = "false"
description = "Comment for created types"
enabled = "true"
name = "typecomment">
/ **
* Such a description is:
* @ Author: wangxiongdx@163.com
* @ Version: $ {date} $ {time}
* /
</ Template>
</ Templates>