Skip to content

生成 jsdoc 格式的注释

请深度思考。

在本次对话内,你将负责帮助我批量修改代码的注释,修改成 jsdoc 格式的注释。

在我提供的文件内,会出现很对不符合 jsdoc 格式的注释,你需要将其全部转换成 jsdoc 格式的注释。

其最终目的是为了使用 jsdoc-to-markdown 完成文件扫描与识别。

目录与术语说明

为了便于你找到目录,识别术语,这里专门罗列出来:

  • 拆分出来的文件目录apps\gitee.jiumengjun.rmmv\sourceCodeFile
  • 进度报告文件apps\gitee.jiumengjun.rmmv\docs\prompts\make-jsdoc-format-annotation\todo.md

可以被修改的文件

你只可以阅读并修改以下我提供的文件地址来读取:

  • apps\gitee.jiumengjun.rmmv\main.js
  • apps\gitee.jiumengjun.rmmv\rpg_core.js
  • apps\gitee.jiumengjun.rmmv\rpg_managers.js
  • apps\gitee.jiumengjun.rmmv\rpg_objects.js
  • apps\gitee.jiumengjun.rmmv\rpg_scenes.js
  • apps\gitee.jiumengjun.rmmv\rpg_sprites.js
  • apps\gitee.jiumengjun.rmmv\rpg_windows.js

这些文件都是目标文件,被处理的文件。

进度报告文件的格式

进度报告文件 ,是记录任务进度的文档。记录项应该同时包括以下的三项任务。

  1. 进度报告文件应该设计成多个分模块的表格。
    • 表格第一列,应该是文件名。
    • 表格的后三列,分别对应以下三个阶段的任务进度。
  2. 报告进度表,应该在每一个表格块内,记录进度信息。
  3. 任务进度用百分比来标记。
  4. 在整个 进度报告文件 最底下,应该包括整体进度的报告。

一阶段任务:代码拆分

模仿其他项目的格式做代码拆分。请你先做代码拆分,再开始根据拆分后的代码,做 jsdoc 的格式转换和翻译工作。

  1. 检查是否存在需要被拆分的文件?检查 拆分出来的文件目录,是否有已经被拆分好的文件?进度报告文件是否已经说明了该阶段已经完成?如果已完成该阶段的代码拆分,那就跳过此部分。否则就继续。
  2. 请你模仿 apps\rmmv-api\sourceCodeFile 目录内的代码拆分方式,将 apps\gitee.jiumengjun.rmmv 目录内的代码拆分到 拆分出来的文件目录 内。
  3. 在你拆分代码时,请你直接地对被处理的目标文件做删除。比如你拆分出来一个模块了,就对应的删除对应的代码。以便逐步地减少目标文件的代码长度,避免你出现单文件 token 超限的情况。
  4. 这些目标文件预期会被全部拆分完,被拆分完全部模块的代码文件,应该被直接删除。
  5. 被拆分的文件名称。不应该包含任何数字前缀。比如 02 Utils.js 文件命名就是不合适的。应该命名为 Utils.js
  6. 拆分代码时,请逐个的拆分。识别好一个类后,就新建文件,写入文件,删除对应的代码片段。
  7. 不要一次性的对一整个很大的 js 文件,同时的,一次性的做代码拆分。

二阶段任务:jsdoc 格式转换

请先完成文件拆分任务后,再开始 jsdoc 的格式转换。

  1. 首先请扫描 拆分出来的文件目录 内全部的 .js 格式代码,这些代码是上一个阶段完成的代码拆分任务的成果。
  2. 提出 jsdoc 格式转换计划,并执行你的计划。
  3. 归纳已经有的模块。
  4. 将全部的模块注释转换进度,写入到 进度报告文件 内。这个文件将作为你的进度记录文件,当你每完成一个模块的注释格式转换后,就在此进度文档内记录进度。

三阶段任务:注释翻译与补全

在该阶段,你只可以去读写 拆分出来的文件目录 内已经拆分好的文件,更改这些文件的注释。

  1. 如果你看到一段注释,有英文,但是没有中文注释时,请补全注释。
  2. 在格式转换的时候,适当的对没有中文的注释,增加中文注释。实现英文翻译成中文注释。
  3. 中文翻译在上面,然后才是英文注释。注意严格的注释顺序。先中文后英文
  4. 保留英文注释。

补全注释

有部分函数是没有任何 jsdoc 注释的,请你补全好 jsdoc,并遵循上述的要求来补全 jsdoc。

  1. 补全中英文注释。
  2. 严格遵守 先中文后英文 的规则。

删除无意义的注释

我不希望代码仍旧保留这些无意义的注释。仅仅保留有意义的 jsdoc 注释即可。

其他注意事项

  1. 在你逐个处理文件的时候,请严格按照进度文件内罗列的文件顺序,逐个的完成文件处理。
  2. 不需要你处理目标 .js 文件产生的任何 typescript 类型报错。
  3. 不要处理任何 lint 错误。
  4. 每完成一个文件的任务后,你不需要再停下来,一直继续处理。
  5. 每完成一个模块后,就去更新进度文件。
  6. 不要停下来给我汇报,请持续的完成你设定的任务。

贡献者

The avatar of contributor named as ruan-cat ruan-cat

页面历史

最近更新