http://www.jindent.com |
|
Next: User Defined Variables |
$declarationName$
which can be used in JavaDoc templates
will be substituted by the name of the corresponding declaration (this can be a method name, class name, field name,
and so on...).$variable$
or %variable%
.
/** * $declarationName$, $declarationType$ * */ |
/** * MyClass, class * */ public class MyClass { ... } |
%variable%
syntax can be used to create JavaDocs in boxes:
/************************************* * %declarationName% * * * *************************************/ |
/************************************* * MyClass * * * *************************************/ public class MyClass { ... } |
%variable%
does not change the alignment of all other template elements.$variable$
inserts its substituted content fluently.Variable name: | Description: | Accessible from template: |
conventioName | Name of used code convention | all |
date | Current date | all |
declarationName | Name of declaration | all JavaDocs |
declarationType | Type of declaration | all JavaDocs |
exceptionName | Name of exception | method/constructor JavaDocs |
fileFormat | File format (Dos, Unix, Mac) | all |
fileName | Short filename of current source file | all |
fullFileName | Full filename of current source file | all |
packageName | Package name of current source file | all |
paramName | Name of parameter | method/constructor JavaDocs |
paramType | Type of parameter | method/constructor JavaDocs |
returnType | Method return type | method JavaDocs |
tabSize | Set output tab size | all |
textFormat | Same as file format (Dos, Unix, Mac) | all |
Convention name |
$conventionName$
or %conventionName%
to resolve it.Date format |
$date$
or %date%
to resolve it.java.text.SimpleDateFormat
to format the current date.
For details how to use its formatting patterns please refer to:
java.text.SimpleDateFormat