admin管理员组

文章数量:1027751

使用CodeBudddy为代码添加注释和log日志的通用方法

“我正在参加CodeBuddy「首席试玩官」内容创作大赛，本文所使用的 CodeBuddy 免费下载链接：腾讯云代码助手 CodeBuddy - AI 时代的智能编程伙伴”；

最近里为了提高团队成员的开发效率，也为了规范大家的开发写法，同时更易于大家写出别人能读的懂的代码，特研究了下，怎么通过腾讯云代码助手 CodeBuddy 给代码添加注释和log日志，这样大家按照需求开发程序，开发完，让codebuddy给统一添加下，然后再提交代码，写出来的代码就比较通俗易懂了，故本次整理下适用于各种项目的前端和后端的通用写法，只需要按照文章里写的通用话术进行提问或者追问即可。

在这里只写了操作方法，具体效果留给试验者哦，看看效果是否有惊艳到你！

通用方法

1、打开vscode或者idea，安装插件【腾讯云ai代码助手】，安装完，就能在ide的左侧或者右侧看到codebuddy的图标

2、点击图图标，使用Craft功能

3、点击对话框里的Add，可以在输入框里搜索要添加注释和log日志的文件

3、选择完文件，配上询问话术

后端的代码，请使用下面这个话术

  1. 这个是****相关的类，包含controller、service、serviceImp、mapper、xml
  2. 解析这些文件，增加类级别的注释说明
  3. 解析这些文件，增加重要方法的注释说明
  4. 解析这些文件，增加复杂业务逻辑的注释说明
  5. 解析这些文件，增加关键操作点的log日志打印
  6. 解析这些文件，增加异常处理的log日志记录
  7. 要解析这些文件的所有地方，一次性加全

8. 不要改动原有代码逻辑，只做log、注释的添加

9. 要将所有改动都直接写入对应的代码里面

前端代码，请使用下面话术

1、这个是我开发的****的相关前端代码

2、这是一个React的前端工程文件

3、请解析这些文件，在ts、tsx、less等文件中添加合理的注释

4、要解析这些文件的所有地方，一次性加全

5、不要改动原有代码写法和逻辑，只做注释的添加

6、要将所有添加的注释都直接写入对应的代码里面

追问话术：

  • ai生成之后，有时候还会改动原先的代码，可以继续让其修改

1、请不要改动原先的代码逻辑，制作注释的添加

2、所有添加的注释都需要直接写入到对应的代码文件里

  • 有的时候AI添加完一部分注释之后，会给出下一步意见，并询问下一步是否继续

1、请根据上面的建议，继续完善

2、需要一次性将所有需要添加注释和打印的地方，都增加全

询问AI时可以适当遵从几个方面，最重要是要拆分成点，不要一句话描述太多内容

1、讲述问题，描述清楚问题，拆分1234点，最好加上示例描述

2、指定目标，告诉模型怎么做，做成什么样，1234描述出来

3、补充要求，例如特定格式

使用CodeBudddy为代码添加注释和log日志的通用方法

“我正在参加CodeBuddy「首席试玩官」内容创作大赛，本文所使用的 CodeBuddy 免费下载链接：腾讯云代码助手 CodeBuddy - AI 时代的智能编程伙伴”；

最近里为了提高团队成员的开发效率，也为了规范大家的开发写法，同时更易于大家写出别人能读的懂的代码，特研究了下，怎么通过腾讯云代码助手 CodeBuddy 给代码添加注释和log日志，这样大家按照需求开发程序，开发完，让codebuddy给统一添加下，然后再提交代码，写出来的代码就比较通俗易懂了，故本次整理下适用于各种项目的前端和后端的通用写法，只需要按照文章里写的通用话术进行提问或者追问即可。

在这里只写了操作方法，具体效果留给试验者哦，看看效果是否有惊艳到你！

通用方法

1、打开vscode或者idea，安装插件【腾讯云ai代码助手】，安装完，就能在ide的左侧或者右侧看到codebuddy的图标

2、点击图图标，使用Craft功能

3、点击对话框里的Add，可以在输入框里搜索要添加注释和log日志的文件

3、选择完文件，配上询问话术

后端的代码，请使用下面这个话术

  1. 这个是****相关的类，包含controller、service、serviceImp、mapper、xml
  2. 解析这些文件，增加类级别的注释说明
  3. 解析这些文件，增加重要方法的注释说明
  4. 解析这些文件，增加复杂业务逻辑的注释说明
  5. 解析这些文件，增加关键操作点的log日志打印
  6. 解析这些文件，增加异常处理的log日志记录
  7. 要解析这些文件的所有地方，一次性加全

8. 不要改动原有代码逻辑，只做log、注释的添加

9. 要将所有改动都直接写入对应的代码里面

前端代码，请使用下面话术

1、这个是我开发的****的相关前端代码

2、这是一个React的前端工程文件

3、请解析这些文件，在ts、tsx、less等文件中添加合理的注释

4、要解析这些文件的所有地方，一次性加全

5、不要改动原有代码写法和逻辑，只做注释的添加

6、要将所有添加的注释都直接写入对应的代码里面

追问话术：

  • ai生成之后，有时候还会改动原先的代码，可以继续让其修改

1、请不要改动原先的代码逻辑，制作注释的添加

2、所有添加的注释都需要直接写入到对应的代码文件里

  • 有的时候AI添加完一部分注释之后，会给出下一步意见，并询问下一步是否继续

1、请根据上面的建议，继续完善

2、需要一次性将所有需要添加注释和打印的地方，都增加全

询问AI时可以适当遵从几个方面，最重要是要拆分成点，不要一句话描述太多内容

1、讲述问题，描述清楚问题，拆分1234点，最好加上示例描述

2、指定目标，告诉模型怎么做，做成什么样，1234描述出来

3、补充要求，例如特定格式

本文标签： 使用CodeBudddy为代码添加注释和log日志的通用方法

版权声明：本文标题：使用CodeBudddy为代码添加注释和log日志的通用方法 内容由热心网友自发贡献，该文观点仅代表作者本人， 转载请联系作者并注明出处：http://it.en369.cn/jiaocheng/1747437915a2166488.html， 本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如发现本站有涉嫌抄袭侵权/违法违规的内容，一经查实，本站将立刻删除。