面向开发者文档的编写和维护，覆盖代码内说明、接口规范、文档站、入门教程、故障排查和常见问题。先确认所需格式与排除范围，再识别语言、框架和缺少说明的公开接口，避免把某一种文档风格直接套到所有项目。
代码说明应交代参数类型、含义、返回行为和可能出现的异常。原文提供多种常见函数说明与脚本注释格式，并按框架区分接口文档策略。简单且含义明显的访问函数不必重复写冗长说明，重点是对使用者有帮助且便于后续维护。
示例必须实际检查：文档测试、类型编译或接口规范校验应采用项目适用的工具。发现示例错误时先修正并重新验证，再报告结果；不能把尚未运行的示例描述为已验证可用。
按任务类型，交付可以是带说明的源码和覆盖报告、接口规范及门户配置、文档站结构与构建方法，或配有示例和示意图的指南。原文列出文档系统、交互式接口门户及常见语言框架的参考文件，便于按当前技术栈继续核对。
引用文档
以下为作者声明的引用来源，保留指定版本、署名和许可。
- jeffallan/claude-skills/skills/code-documenter/SKILL.md — 署名：Jeffallan；许可：MIT；版本：
3bf9a24b76a7c122f1fc05e83929fbc84e1c207a。