工具概览
lean-comments 是一个 Agent Skill,只在源码注释携带了代码及其上下文无法表达的信息时才保留注释。它会删除注释,缩短并改写那些值得保留的注释,其余的直接移除而不是重新措辞。该技能对每条普通注释(无论是已有的还是拟新增的)进行必要性检验,判断如果没有这条注释,称职的维护者是否会丢失有意义且不显而易见的信息。它先确定必要性再考虑措辞,因此不必要的注释不会被润色成更好的不必要注释,也不会为了保留而被拔高成文档。该技能处理行注释、文档注释、docstring 和文件头,并在证实过时之前保留 lint、编译器和许可证注释。它可按需审计整个仓库,并按 17 条标准检查 diff;限定范围的 diff 只涉及有人维护的第一方代码,跳过生成和第三方引入的内容。
定价
价格与限制可能变化,请以官网为准,并确认币种、付款周期、最低席位数和用量上限。
应用场景
- 团队用 lean-comments 审计某个源码目录中的注释。
- 团队用 lean-comments 清理 diff 中的注释。
- 团队用 lean-comments 评估某个 docstring 是否值得保留。
- 团队用 lean-comments 查找文件中过时的 TODO。
- 团队用 lean-comments 审查某次改动涉及的注释。
- 团队用 lean-comments 在编写代码时应用同样的检验。
功能特性
删除没有补充信息的注释
精简确有保留价值的注释
避免编造保留注释的理由
通过改进代码减少注释需求
只在必要时记录声明契约
检查行注释和文档字符串
保留仍然有效的工具指令注释
按既定标准审查仓库注释
用户评论
还没有评论,来分享你的使用体验吧