VSCode注释高亮(# NOTE;# TODO;# FIXME;#XXX;# HACK;# BUG)

注释格式 说明
# NOTE: 用于标记需要注意的地方,如重要信息、提示等
# TODO: 用于标记待办事项,提醒开发者需要完成的任务
# FIXME: 用于标记需要修复的问题,通常是在代码中已知的错误或需要改进的地方
# XXX: 用于标记代码中需要注意的地方,可能是一些潜在的问题或需要注意的细节
# HACK: 用于标记一些临时的、不太优雅的解决方案,通常是为了快速解决问题而采取的权宜之计
# BUG: 用于标记已知的bug,提醒开发者需要修复
python 复制代码
# NOTE: 这里是一个重要的配置项
important_config = True

# TODO: 添加异常处理逻辑
def divide(a, b):
    return a / b

# FIXME: 这里的循环逻辑有误,需要重新调整
def process_data(data):
    for i in range(len(data) + 1):  # 这里可能会越界
        print(data[i])

# XXX: 这里的参数值可能需要根据实际情况进行调整
def calculate_score(points, multiplier=2):
    return points * multiplier

# HACK: 暂时使用这种方法来绕过这个问题,后续需要找到更合适的解决方案
def quick_fix():
    # 这里是一个临时的解决方案
    pass

# BUG: 这里存在一个内存泄漏的问题
def memory_leak():
    # 这里是可能导致内存泄漏的代码
    pass

相关推荐
夜雪一千12 分钟前
如何使用Python的BeautifulSoup库来处理HTML
python
傻啦嘿哟13 分钟前
某新闻平台爬虫:爬取各频道新闻,分析媒体传播规律
python
鹿角片ljp20 分钟前
Prompt Cache、Token 成本与 Plan Compiler 的工程设计
java·python·算法
郝学胜-神的一滴22 分钟前
C++20模板元编程 05:吃透变参模板,解锁编译期万能参数能力
服务器·开发语言·c++·windows·vscode
麻雀飞吧9 小时前
先判断工具用来学习、开发还是执行
人工智能·python
人邮异步社区9 小时前
学习Python的最佳学习路径是什么?
python·程序员
troy12812 小时前
Python 基础语法(九):Django/Flask/FastAPI 三大 Web 框架详细对比解析
python·jupyter·django·flask·github·fastapi
jzshmyt12 小时前
我用 Python 从零“生成“了一个宇宙,然后让它观察自己(v14)
人工智能·pytorch·python·numpy·matplotlib·空间计算·scipy
用户83562907805114 小时前
使用 Python 将 DOCX 转换为 Markdown
后端·python
小玮看世界14 小时前
[Python]ADAS工程实战(三):多传感器扇区统计疑难点全解——归一化、跨边界、去重与置信度
python