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:如果代码中有该标记,说明此处代码是作者做的笔记或者是简要说明。
相关推荐
风逸hhh2 分钟前
python打卡day58@浙大疏锦行
开发语言·python
烛阴1 小时前
一文搞懂 Python 闭包:让你的代码瞬间“高级”起来!
前端·python
JosieBook1 小时前
【Java编程动手学】Java中的数组与集合
java·开发语言·python
Gyoku Mint2 小时前
深度学习×第4卷:Pytorch实战——她第一次用张量去拟合你的轨迹
人工智能·pytorch·python·深度学习·神经网络·算法·聚类
郭庆汝8 小时前
pytorch、torchvision与python版本对应关系
人工智能·pytorch·python
思则变11 小时前
[Pytest] [Part 2]增加 log功能
开发语言·python·pytest
漫谈网络11 小时前
WebSocket 在前后端的完整使用流程
javascript·python·websocket
巴里巴气11 小时前
2025.1版本PyCharam找不到已存在的conda虚拟环境
pycharm·conda
try2find13 小时前
安装llama-cpp-python踩坑记
开发语言·python·llama
博观而约取14 小时前
Django ORM 1. 创建模型(Model)
数据库·python·django