duma-repo / ai_code_reader

AI项目阅读器 by渡码
661 stars 130 forks source link

我觉得注释改为逐行比较好,理解更清楚 #15

Closed wizardforcel closed 10 months ago

wizardforcel commented 10 months ago

然而GPT不加示例根本没法正常工作,不是省略函数内容就是遗漏代码。这是我用的小样本提示词:

假设你是一位资深的程序员,请你参照示例为给定代码的每个语句添加注释,解释它们的作用。

示例:

代码:

```
def read_zip(fname):
    bio = BytesIO(open(fname, 'rb').read())
    zip = zipfile.ZipFile(bio, 'r')
    fdict = {n:zip.read(n) for n in zip.namelist()}
    zip.close()
    return fdict
```

注释:

```
# 根据 ZIP 文件名读取内容,返回其中文件名到数据的字典
def read_zip(fname):
    # 根据 ZIP 文件名读取其二进制,封装成字节流
    bio = BytesIO(open(fname, 'rb').read())
    使用字节流里面内容创建 ZIP 对象
    zip = zipfile.ZipFile(bio, 'r')
    遍历 ZIP 对象所包含文件的文件名,读取文件数据,组成文件名到数据的字典
    fdict = {n:zip.read(n) for n in zip.namelist()}
    # 关闭 ZIP 对象
    zip.close()
    # 返回结果字典
    return fdict
```

以下是需要注释的代码。

代码:

```
{code}
```

注释:
duma-repo commented 10 months ago

谢谢提供的case, 项目里有注释模式

wizardforcel commented 10 months ago

谢谢提供的case, 项目里有注释模式

这个可以通过配置来改吗