Idea中的那些你可能不知道的注释技巧

60 阅读1分钟

1. 关闭代码格式化

  • @formatter:off@formatter:on 标签之间的代码不会被格式化

有时候IDE的自动格式化效果可能不理想,如果想让某一代码片段不被格式化,可以将其写在这两个标签之间。

// @formatter:off

public static void method() {
	....
}

// @formatter:on
<!-- @formatter:off -->

<tag>
	...
</tag>

<!-- @formatter:on -->

2. 自定义代码折叠块

region {text}endregion 之间的代码会被识别为一个代码块儿,可以被一块儿折叠起来。

// region 折叠的代码信息,哎呀,我被折叠了  
List<TfjDto> listCurrentData(@Param("dataGroup") String dataGroup,  
                             @Param("areaId") Integer areaId,  
                             @Param("startTime") Date start,  
                             @Param("endTime") Date end);  
// endregion

image.png

折叠后如下:

image.png

3. 代码标识

  • // TODO , 表示要实现还没有实现的代码
  • // FIXME , 表示存在问题的代码

代码中的这两种标识都可以在Idea的TODO面板中检索到

image.png

自定义标记

除了 Idea 出厂自带的这两个标记,还可以自定义标记,在【设置】-> 【编辑器】-> 【TODO】中,可以添加自定义的标记,比如我们添加一个 changeme 的标记,表示这一段代码可能需要被修改。

image.png 这样,在代码里面就可以像使用 TODO 一样使用 ChangeMe 了。

image.png