对于todo及在使用todo快捷键时对其中具体时间参数的设置
文章目录
对于todo的介绍
在日常开发中的某些时候,
我们有时需要对方法进行一些标记,
可是javadoc对于提醒的方便程度,并不足以满足我们对于一个方便查看的标记的需求。
这时候,TODO就是一个很好的选择
其实就是类似于标记的作用,可以很快的定位到这个位置,方便查找,如图:
对于todo的菜单在idea(2023.03)版本中如何打开
大家升级到idea的2023.03版之后,一些平时常用的选项没有显示在边栏上,其实在边栏中三个点的地方打开就好了
还可以拖放在任何你喜欢的地方
对于todo菜单中各项的内容
在todo菜单中,上方有四个选项,分别为
project: 在项目中
current file: 在当前文件中
scope based: 选择文件(可以选择)
changes changelist: 更改变更列表
可以按自己的需要打开对应的菜单
左侧菜单分别为
上一个
下一个
筛选
点击跳转到对应的标记处
全部打开
全部收起
按什么分组
在右侧打开对应的标记位置的代码窗口(如下图)
对于自己的todo如何设置
设置在settings / editor / todo中,筛选在他的下面
点击加号,仿照着写一个就好了
对于todo的筛选在设置中如何设置
筛选可以在settings / editor / todo中,设置在他的上面
在红框中设置即可,可以一条对应上方多个规则
使用时
请在此处使用
对于使用快捷键生成todo
在settings / editor / live templates中
live template:添加一条模板
template group:添加一个模板组
推荐创建一个新组,方便管理(名字是自己起的,像是什么user,custom等你在原生列表中没见过的都是)
对于使用todo快捷键时对其中具体时间参数的设置(了解过其他的直接看这个)
赋值可以在expression
选择函数,或是在Default value
中写一些字符串,方法等
下面用一些例子来说明
写在Default value
中也一样
在skip if defined中的勾选上以后不会再出现对于内容更改的输入框(出现时如下)
对于时间的todo的使用
推荐
template text
// version: $className$ $methodName$ $user$ $date$ $time$
参数
(“xxx”)请写自己的名称
这样可以生成一个 类名 方法名 书写人 日期 时间的版本说明,当然也可以加方法说明改为todo之类的
对于模板中函数的说明
我们发现这里好像有一些函数,可以点开看看
下面是它们部分的介绍
函数 | 描述 |
---|---|
annotated(“annotation qname”) | 使用驻留在指定位置的注释创建类型符号。 例如,请参见迭代组中的活动模板。 |
anonymousSuper() | 为Kotlin对象表达式建议一个超类型。 |
arrayVariable() | 建议当前作用域中适用的所有数组变量。 例如,请参见迭代组中的活动模板。 |
blockCommentEnd | 返回在当前语言上下文中指示块注释结束的字符。 |
blockCommentStart | 返回在当前语言上下文中指示块注释开始的字符。 |
camelCase(String) | 将字符串转换为camelCase。 例如,camelCase(my-text-file)、camelCase(my text file)和camelCase(my_text_file)都返回myTextFile。 |
capitalize(String) | 将参数的第一个字母大写。 |
capitalizeAndUnderscore(sCamelCaseName) | 将作为参数传递的CamelCase名称的所有字母大写,并在各部分之间插入下划线。例如,大写和下划线(FooBar)返回FOO_BAR。 |
castToLeftSideType() | 将右侧表达式转换为左侧表达式类型。在迭代组中,它使用一个模板来生成raw类型和泛型集合。 |
className() | 返回当前类的名称(展开模板的类)。 |
classNameComplete() | 这个表达式替代了变量位置上的类名补全。 |
clipboard() | 返回系统剪贴板的内容。 |
commentEnd() | 返回指示当前语言上下文中注释结尾的字符。如果行注释是用当前语言定义的,则返回值为空。 |
commentStart() | 返回指示当前语言上下文中注释开头的字符。如果行注释是用当前语言定义的,则它们的开始指示符更好。 |
complete() | 在变量的位置调用代码完成。 |
completeSmart() | 在变量的位置调用智能类型完成。 |
componentTypeOf() | 返回数组的组件类型。有关示例,请参见迭代组和其他组中的活动模板。 |
concat(expressions…) | 返回作为参数传递给函数的所有字符串的串联。 |
currentPackage() | 返回当前包名称。 |
date(sDate) | 如果没有参数,则以默认系统格式返回当前日期。 |
decapitalize(sName) | 将参数的第一个字母替换为相应的小写字母。 |
descendantClassEnum() | 返回指定为字符串参数的类的子级。 |
enum(sCompletionString1,sCompletionString2,…) | 返回在扩展模板时建议完成的逗号分隔字符串列表。 |
escapeString(sEscapeString) | 转义指定为参数的字符串。 |
expectedType() | 返回模板扩展到的表达式的预期类型。如果模板在赋值的右部分、返回后等展开,则很有意义。 |
fileName() | 返回当前文件的名称及其扩展名。 |
fileNameWithoutExtension() | 返回不带扩展名的当前文件的名称。 |
firstWord(sFirstWord) | 返回作为参数传递的字符串的第一个字。 |
groovyScript(“groovy code”, arg1) | 返回具有指定代码的groovy脚本。 可以将groovyscript()函数与多个参数一起使用。第一个参数是所执行脚本的文本或包含脚本的文件的路径。下一个参数绑定到脚本中可用的_1、_2、_3、…_n变量。此外,脚本中还提供了_editor变量。此变量绑定到当前编辑器。 |
guessElementType () | 猜测java.util.collection中存储的元素类型。为了猜测,intellij想法试图找到元素添加到容器或从容器中提取的位置。 |
iterableComponentType() | 返回可iterable组件的类型,如数组或集合。 |
iterableVariable() | 返回可迭代的变量的名称。 |
JsArrayVariable() | 返回当前javascript数组的名称。 |
jsClassName() | 返回当前javascript类的名称。 |
jsComponentTypeOf() | 返回当前javascript组件的类型。 |
jsDefineParameter | 基于模块的名称,返回参数fromdefine([“module”]、function(<parameter_in_question>>))。 |
jsMethodName() | 返回当前javascript方法的名称。 |
jsQualifiedClassName() | 返回当前javascript类的完整名称。 |
jsSuggestIndexName() | 返回最常用的索引变量的建议名称:i、j、k等。当前作用域中尚未使用的名称将首先显示。 |
jsSuggestVariableName() | 根据引用变量命名规则的代码样式设置,基于变量类型和初始值设定项表达式返回变量的建议名称。 例如,如果它是一个在迭代中保存元素的变量,那么intellij-idea会猜测最合理的名称,并考虑到被迭代的容器的名称。 |
jsSuggestDefaultVariableKind(Boolean) | 布尔参数确定当前上下文中是否允许常量。如果未指定参数,则允许使用常量。当模板展开时,将显示一个下拉列表,其中包含typescript和es6的var、let和const选项,以及早期javascript版本的一个var选项。 |
jsSuggestImportedEntityName() | 根据文件名,将’import类型的import语句的名称建议为from“”`或’importfrom“”。 |
lineCommentStart | 返回在当前语言上下文中指示行注释开头的字符。 |
lineNumber() | 返回当前行号。 |
lowercaseAndDash(String) | 将camelcase字符串转换为小写,并插入n个破折号作为分隔符。例如,LowerCaseandDash(MyExampleName)返回我的示例名称。 |
methodName() | 返回展开模板的方法的名称。 |
methodParameters() | 返回展开模板的方法的参数列表。 |
methodReturnType() | 返回当前方法返回的值的类型(模板在其中展开)。 |
qualifiedClassName() | 返回当前类的完全限定名(在其中展开模板)。 |
rightSideType() | 用右侧表达式的类型声明左侧变量。在迭代组中,它使用一个模板来生成原始类型和泛型集合。 |
snakeCase(String) | 将字符串转换为蛇形大小写。例如,snakecase(foo bar)返回foo_bar。 |
spaceSeparated(String) | 将字符串转换为小写并插入空格作为分隔符。例如,spaceseparated(foo bar)返回foo bar。 |
substringBefore(String,Delimiter) | 删除指定分隔符后的扩展名并仅返回文件名。这有助于测试文件名(例如,substringbefore(,“.”)返回component test.js中的组件测试。 |
subtypes(sType) | 返回作为参数传递的类型的子类型。 |
suggestFirstVariableName(sFirstVariableName) | 不代表真的,假的,这个,超级的。 |
suggestIndexName() | 建议使用最常用的索引变量的名称:i、j、k等(第一个不在当前范围内使用的变量)。 |
suggestVariableName() | 根据引用变量命名规则的代码样式设置,基于变量类型及其初始值设定项表达式建议变量的名称。例如,如果它是一个在迭代中保存元素的变量,那么intellij-idea会猜测最合理的名称,并考虑到要迭代的容器的名称。 |
time(sSystemTime) | 以指定格式返回当前系统时间。 |
typeOfVariable(VAR) | 返回作为参数传递的变量的类型。 |
underscoresToCamelCase(String) | 用作为参数传递的字符串中的camelcase字母替换下划线。例如,underlinestocamelcase(foo_bar)返回foo bar。 |
underscoresToSpaces(sParameterWithUnderscores) | 用作为参数传递的字符串中的空格替换下划线。例如,underlinestospaces(foo_bar)返回foo bar。 |
user() | 返回当前用户的名称。 |
variableOfType() | 建议可以分配给作为参数传递的类型的所有变量,例如,VababeLoFype(“java. U.L.Vector”)。如果传递一个空字符串(“”)作为参数,那么函数将建议所有变量,而不管其类型如何。 |
参考文章:
IDEA中TODO的使用、配置和设置TODO过滤器_idea todo-CSDN博客
IntelliJ IDEA编辑模板变量详解(Edit Template Variables)_idea自定义模板变量-CSDN博客