OpenCode 全局开发规范是一个详尽的指南，旨在提高开发效率和代码质量。规范涵盖了代码风格、回复习惯、操作确认规范、内存优化规范等多个方面。以下是对该规范的详细解读和优化建议。

代码风格

  • 命名规范：使用清晰、描述性的变量和函数名，遵循驼峰或蛇形命名法。
  • 避免过度工程化：优先编写直观的线性逻辑，仅在逻辑会被复用3次以上时才考虑拆分组件或使用Hook。
  • 现代性：使用目标语言的最现代语法特性，如ES2022+、React 19+、Python 3.12+等。
  • 健壮性：考虑边界条件，提供必要的文档注释或类型声明。
  • UI规范：所有样式使用Tailwind CSS，禁止使用原生CSS模块或行内Style（除非动态计算位置）。

回复习惯

  • 回复简洁明了，直接给出代码或解决方案，使用中文回复，便于理解。
  • 如果修改代码，解释关键变更点，不啰嗦。
  • 涉及破坏性操作前先确认。

操作确认规范

  • 必须确认（阻断执行，等待用户明确同意）：包括git push --force、git reset --hard、git rebase、git clean -fd等危险操作，以及删除文件、数据库操作、关键配置修改、依赖操作、构建/部署等。
  • 推荐确认（给出警告，说明风险）：包括大范围重构、API接口签名变更、公共函数/类的重命名或删除、数据结构变更等。
  • 无需确认：代码格式化、添加注释或文档、修改日志输出、单文件小改动、添加测试用例、README或文档更新等。

内存优化规范

  • 核心原则：工作完成后立即background_cancel(all=true)，优先使用轻量工具（grep/read/LSP）而非Agent，控制并发任务数量在2-3个以内。
  • 工具选择优先级：代码搜索使用AUGMCP_search_context > grep > explore agent；文件操作使用glob > bash find；符号查找使用lsp_goto_definition > grep；lsp_find_references > grep；lsp_workspace_symbols > explore。
  • 并发控制：最多同时2-3个background_task，大型重构任务可临时放宽到4-5个，但需明确告知用户原因。
  • 资源清理检查清单：必须执行background_cancel(all=true)和停止所有background_process，推荐执行避免对同一文件重复read，优化建议包括使用精确的Agent提示词、处理大文件时使用read的offset/limit参数等。

触发时机

  • 代码搜索任务使用工具选择优先级，大范围重构启用并发控制和资源清理，完成任务交付执行必须清理项，Token使用>100K时严格遵守所有规则，内存告警立即执行所有清理检查清单。

性能指标参考

  • Token使用量<50K为轻量任务，50-100K为中等任务，>100K为重度任务，>150K为超重任务，考虑拆分任务或新session。

通过遵循这些规范，开发者可以提高代码质量，减少错误，并优化开发流程。同时，规范的详细说明和明确的操作指引也有助于新成员快速融入团队，提升整体开发效率。

标签: none

评论已关闭