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

相关推荐
weelinking3 小时前
【产品】12_接入数据库——让数据永久保存
jvm·数据库·python·react.js·数据挖掘·前端框架·产品经理
程序大视界4 小时前
【Python系列课程】Python正则表达式(下):环视、命名分组与日志实战
开发语言·python·正则表达式
TickDB4 小时前
美股行情 API 接入避坑:REST 快照、WebSocket 推送、盘前盘后数据的边界
人工智能·python·websocket·行情数据 api
枫叶v.4 小时前
Agent 分层存储架构设计:从记忆方法到中间件选型
开发语言·python
水兵没月5 小时前
逆向实战小记——某ToB商城网站分析学习
python·网络爬虫
程序员小远5 小时前
Python自动化测试框架及工具详解
自动化测试·软件测试·python·测试工具·职场和发展·测试用例·接口测试
sleven fung6 小时前
MinerU与BabelDOC与KTransformers与OpenAI API库
开发语言·python·ai·langchain
小毛驴8506 小时前
spring-boot-maven-plugin,maven-compiler-plugin 功能对比
java·python·maven
萤萤七悬6 小时前
【Python笔记】AI帮实现CLI工具-使用argparse.ArgumentParser接收命令参数
开发语言·笔记·python
霸道流氓气质6 小时前
通义灵码 IDEA 插件完全使用指南
java·ide·intellij-idea