SuperAPI AI 工具集

clean-codejs-comments

编程与开发

查看项目

更新于 10-15 20:31

技能介绍

用途:该技能面向 JavaScript 代码中的注释编写,目标是通过一致的注释规范提升代码的可读性与可维护性,属于 Clean Code JavaScript 系列中的注释主题。

主要能力:提供何时注释与何时不注释的判断准则,并配有正反示例。准则包括:注释应解释“为什么”而不是“做什么”;用于记录复杂的业务规则;避免为显而易见的代码添加注释;避免保留已经过时的解释性注释。

示例:反面写法为 // ❌ Bad 下的 // Increment i by 1 与 i++;;正面写法为 // ✅ Good 下的 // Retry once to handle flaky network condition 与 retryRequest();。

适用场景:适用于 JavaScript 项目的代码评审与日常编写,帮助团队统一注释风格,减少冗余注释并保留必要的上下文说明。

限制:现有资料仅给出上述原则与示例,未提供安装命令、具体用法步骤、支持的平台与版本、收费或价格等信息,这些内容暂未提供。