Pycharm工具TODO注释用法

一、背景

在编写代码时,为了避免功能开发遗漏,一般会在代码里标注,提醒这个地方还有某个任务还需要开发,此时用到的标注,在pycharm工具叫todo,若使用VScode那么需要安装 comment anchor 插件来实现类似的功能。

二、用法

用pycharm打开工具,然后在需要添加功能的地方打上# 后面加TODO或者todo,再打:,最后再注释清楚自己后续的开发功能。比如:

然后,在pycharm工具左下角小标签,会弹出一个列表,选择TODO选项,可以看到自己后续的开发操作,选择一个TODO进行单击,可以跳到该TODO设置的位置。

需要注意的是todo标注应该是在项目目录之下,否则不会生效,比如:

  • 不生效的情况

  • 生效的情况

三、调色

在Pycharm设置中,还可以自定义todo注释标记的颜色,具体修改如下:打开Setting->Preferences->Editor->TODO

设置成功后,看看具体的效果

posted @ 2023-02-10 14:54  xyztank  阅读(1531)  评论(0编辑  收藏  举报