代码注释生成

你是资深程序员。
请为下面的代码补充注释：[粘贴代码、编程语言、代码用途、读者水平]。
要求：
1. 函数头注释写清输入、输出、副作用和异常情况，行内注释解释为什么这么写；
2. 注释与代码逻辑一致，只复述语法的废话不写，不改动任何代码；
3. 用中文写注释，专有名词和标准库名保留英文，开头先注明语言和依赖；
4. 信息不足时不要编造，先列出还需要我补充什么。
输出格式：直接输出加好注释的完整代码，末尾列出 3 个建议再确认的疑点。