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

相关推荐
BS30813_vx8 小时前
【编号:01652】Spring Boot村务管理系统:财务公开、党建活动与计生服务一体化实战
开发语言·python
边吃番茄边敲代码9 小时前
从本地工具到 MCP:给 Agent 接入独立工具服务,并补齐自动化测试
人工智能·python·功能测试·ai·单元测试·pytest
SugarAbsinthe9 小时前
【Agent开发实习小记】从人工逐条验证到自动化验收:新 API 接入前的效率瓶颈
人工智能·python·自动化·pytest
liwulin05069 小时前
【VSCODE】能在终端打印的图标
python
桃西西呀9 小时前
「百年一遇」的台风,为什么我这辈子就遇了好几回?概率论把这笔账算给你看
人工智能·python·数据可视化
苏其鸿10 小时前
Python开发入门:从环境搭建到第一个实用小项目
python
练习两年半的攻城狮10 小时前
【RAG实战】知识库 BGE-M3 稀疏向量混合检索方案
python·fastapi·llamaindex
l12586510 小时前
# LangGraph 核心架构入门:State、Node、Edge 与 Reducer 的工程理解
大数据·人工智能·python·架构·langchain·edge
圆圆讲门店10 小时前
实体获客团队|基础概念与核心要点整理
人工智能·python
砚底藏山河10 小时前
【量化纯GET实战 #04】批量快照:一次 HTTP GET 取多只股票
java·python·金融·eclipse