PyCharm 中的特殊标记

在使用 PyCharm 开发 Python 项目的时候,经常会有一些特殊的标记,有些是 IDE 提示的代码规范,有些则为了方便查找而自定义的标记。

我在之前写过一些关于异常捕获的文章:Python3 PyCharm 捕获异常报 Too broad exception clause 警告

如果不确定有可能发生的错误,或者是就要使用 Exception 而且还不许 PyCharm 抱怨,就需要关闭编译器中代码检测中有关检测 Exception 的选项,在 try 语句前加入 # noinspection PyBroadException 即可。

python 复制代码
# noinspection PyBroadException
try:
       pass
except Exception as e:
        pass

这次介绍 PyCharm 的特殊标记是 TODOFIXME,废话不多说,直接看图:

  • TODO:待办事项,如果代码中有该标记,说明此处代码可能有新功能增加或者有未完成的细节需要以后慢慢优化。
  • FIXME:此处待修理 ,如果代码中有该标记,说明此处代码有待修复的 BUG 或者是有逻辑错误需要立即修复。

如果有同学写过 Java 或者其他语言,用过 Eclipse 或其他 IDE 的一定还知道其他的特殊标记,比如:

  • XXX:如果代码中有该标记,说此处代码虽然实现了功能,但是实现的方法有待商榷,希望将来能改进,要改进的地方会在说明中简略说明。
  • HACK:如果代码中有该标记,说明此处代码我们需要根据自己的需求去调整程序代码。
  • BUG: 如果代码中有该标记,说明此处代码有 BUG
  • NOTE:如果代码中有该标记,说明此处代码是作者做的笔记或者是简要说明。
相关推荐
databook5 小时前
Manim实现脉冲闪烁特效
后端·python·动效
程序设计实验室5 小时前
2025年了,在 Django 之外,Python Web 框架还能怎么选?
python
倔强青铜三7 小时前
苦练Python第46天:文件写入与上下文管理器
人工智能·python·面试
用户25191624271110 小时前
Python之语言特点
python
刘立军11 小时前
使用pyHugeGraph查询HugeGraph图数据
python·graphql
数据智能老司机14 小时前
精通 Python 设计模式——创建型设计模式
python·设计模式·架构
数据智能老司机15 小时前
精通 Python 设计模式——SOLID 原则
python·设计模式·架构
c8i16 小时前
django中的FBV 和 CBV
python·django
c8i16 小时前
python中的闭包和装饰器
python
这里有鱼汤20 小时前
小白必看:QMT里的miniQMT入门教程
后端·python