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

相关推荐
ningmengjing_8 小时前
Redis 从入门到实战:Python操作全攻略
数据库·redis·python
️学习的小王8 小时前
智能文档助手:基于RAG的本地化文档问答系统实战指南
人工智能·python·机器学习
不瘦80斤不改名8 小时前
05-vibe-coding-向agentic-engineering演进
人工智能·笔记·python·prompt
笨鸟先飞,勤能补拙9 小时前
AI 安全的下一个 5 年:从 Agent 到 AGI 的攻防博弈
人工智能·python·安全·web安全·网络安全·github·agi
Logintern099 小时前
LangSmith如何根据id关系,在服务端把扁平列表重建为树形结构,用于页面渲染Trace视图
python
月光船幽幽9 小时前
呼吸孔设计重塑系统稳定性
python·科技·算法
Bryce学亮10 小时前
FileLine,基于 Qt 6 + QML 构建的跨平台文件传输与即时通讯工具
数据库·c++·人工智能·python·qt·github
拿铁铁10 小时前
2026实操场景下平板坡口机噪音问题注意事项梳理汇总
python·电脑
夜雪一千10 小时前
Python从HTML提取纯文本、去空格、比对内容是否变化:方案+合理性分析
开发语言·python·html