Create live templates
The following example procedure illustrates how to create a template for a TODO
comment with the current date and user name.
Press Ctrl+Alt+S to open the IDE settings and select Editor | Live Templates.
Select the template group where you want to create a new live template (for example, other).
If you do not select a template group, the live template will be added to the user group.
Click
and select Live Template.
In the Abbreviation field, specify the characters that will be used to expand the template. For example:
todo
. You can also define the languages to apply the newly added template.(Optional) In the Description field, describe the template for reference in the future.
For example:
Insert TODO comment with the current date and username
In the Template text field, specify the body of the template with variables.
For example:
# TODO $DATE$ $USER$: $END$
Click Edit variables to define the variables using functions:
Name
Expression
Default value
Skip if defined
DATE
date()
None
Yes
USER
user()
None
Yes
You can set a default value for cases when the expression fails to evaluate, although these particular functions should always return a valid value. You can also disable the Skip if defined option for a variable to highlight the expanded value and let the user modify it if necessary.
Apply all your changes.
In the editor, type
todo
and press Tab.Depending on the current system date and username, the template should expand to something like:
# TODO 09/02/2021 jetbrains:
Gif
Thanks for your feedback!