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:如果代码中有该标记,说明此处代码是作者做的笔记或者是简要说明。
相关推荐
Kratzdisteln1 分钟前
【Python OOP Diary 1.1】题目二:简单计算器,改错与优化
python·面向对象编程
小白银子9 分钟前
零基础从头教学Linux(Day 53)
linux·运维·python
skywalk816339 分钟前
基于频域的数字盲水印blind-watermark
linux·开发语言·python
applepie_max44 分钟前
GraphRAG本地部署 v2.7.0
python·rag·graphrag
sulikey1 小时前
从零配置一个规范的 Python Git 仓库(适用于 Gitee / GitHub)
git·python·pycharm·gitee·github
shaominjin1231 小时前
android在sd卡中可以mkdir, 但是不可以createNewFile
android·开发语言·python
我是华为OD~HR~栗栗呀2 小时前
华为od-22届考研-测试面经
java·c++·python·功能测试·华为od·华为·面试
学习路上_write2 小时前
神经网络初次学习收获
人工智能·python
大邳草民3 小时前
Django 的动态特性:从 Python 动态机制到框架设计思想
笔记·python·django
用户3721574261353 小时前
Python 裁剪 PDF 教程:轻松裁剪页面并导出为图片
python