Communitygithub.com

chonamdoo/注释撰写规范

在代码实现过程中以及最终评审、多人评审或架构评审之前的注释质量检查中,应用注释质量标准。适用于 Codex、Claude 和 OMP 环境下的 Python、Kotlin、React Web、React Native、iOS、Swift 和 SwiftUI 项目。

注释撰写规范 是什么?

该技能旨在帮助开发者在编码实现阶段和最终评审前实施注释质量标准,确保代码注释清晰、一致且有实际价值。它适用于多种开发平台(如 Codex、Claude、OMP)和多种编程语言(包括 Python、Kotlin、React Web、React Native、iOS、Swift、SwiftUI),覆盖面广。技能的核心流程包括:在代码修改过程中始终遵循注释规范,以及在提交最终评审、多人评审或架构评审之前进行专门的注释质量审查。通过这种方式,可以减少无意义或误导性的注释,提升代码可读性和团队协作效率。该技能特别适合需要严格代码审查流程的团队,能有效避免因注释质量不佳导致的沟通误解和维护成本增加。

兼容平台✓Claude Code✓Codex CLI~Cursor
npx skills add https://github.com/chonamdoo/agent-flow/tree/main/skills/comment-authoring-discipline

在你喜欢的 AI 中提问

打开一个已预加载此 Agent Skill 的新对话。

文档

注释撰写规范 是做什么的?

在代码实现过程中以及最终评审、多人评审或架构评审之前的注释质量检查中,应用注释质量标准。适用于 Codex、Claude 和 OMP 环境下的 Python、Kotlin、React Web、React Native、iOS、Swift 和 SwiftUI 项目。

Individual skills in this repo

This repo contains 5 individual skills — each has its own dedicated page.

chonamdoo/code-generation-discipline

Common code generation and code modification discipline for agent-flow. Use before and during implementation, TDD red/green/refactor, fix-loop, bug fixes, feature work, and any task where Codex, Claude, OMP, or another agent writes or changes code. Enforces start-before, during-implementation, and after-implementation checks without a scoring rubric.

chonamdoo/flutter-development-guide

Flutter implementation and review checklist. Use only when writing, modifying, or reviewing Flutter widget code, layout constraints, adaptive sizing, navigation and routing, platform channels, platform views, background entry points, list and image performance, async gaps across `BuildContext`, disposal, theme and design tokens, accessibility, localization, offline and error states, or Flutter test and golden coverage. Do not use for Dart language generalities, native Android or iOS internals beyond the engine and channel-registration seam a Dart entry point depends on, or broad rewrites.

chonamdoo/ios-app-shell-error-handling

Use when implementing or reviewing iOS app-wide error handling where SwiftUI views/ViewModels notify common errors and an @main App, WindowGroup AppShell, NavigationStack coordinator, or UIKit AppCoordinator owns root navigation, tab/session flow switching, alerts, sheets, toast hosts, SessionExpired handling, Maintenance handling, and root reset behavior.

chonamdoo/ios-clean-presentation-architecture

Use when creating, modifying, or reviewing an iOS Clean Architecture presentation layer with SwiftUI/UIKit state holders, explicit UiState, UiModel mapping, dependency injection, and state-based presentation code review.

chonamdoo/to-prd

Synthesizes the current conversation and codebase context into a PRD, then writes or publishes it according to the caller's requested output target. Use when the user asks to turn an already-discussed idea, plan, or conversation into a PRD; use `grilling` first if key decisions are still unresolved.

相关技能