本文已参与「新人创作礼」活动,一起开启掘金创作之路。
IDEA只有两种特殊注释:
TODO: + 说明: 如果代码中有该标识,说明在标识处有功能代码待编写,待实现的功能在说明中会简略说明。 FIXME: + 说明: 如果代码中有该标识,说明标识处代码需要修正,甚至代码是错误的,不能工作,需要修复,如何修正会在说明中简略说明。
然后我就想有时候,我把这个方法主要是干什么的,我也想把这个注释整高亮,但是TODO、FIXME作为标记的话,那么是不规范的。
很显然,有时候并不够用,在此推荐大家添加新的特殊注释,我添加了一个keypoint,表示这里是关键点,非常常用,具体操作过程如下:
随后
一直到这样,就完成了
演示效果:
但是不知道字段 NOTES 是否符合规范,如果有大佬指点,欢迎批评!!!
推荐,尽量的在个人的项目使用就写了,如果公司使用,最好提交的时候,删除!!!!