Comments are very useful to the flow of code development. With the increasing commonality of code, novice coders have been creating a significant amount of codebases. Due to lack of commenting standards, their comments are often useless, and increase the time taken to further maintain codes. This study intends to find the usefulness of large language models (LLMs) in these cases to generate potentially better comments. This study focuses on the feasibility of design documents as a context for the LLMs to generate more useful comments, as design documents are often used by maintainers to understand code when comments do not suffice.
翻译:注释对于代码开发流程非常有用。随着代码的日益普遍,新手程序员已创建了大量代码库。由于缺乏注释标准,他们的注释往往无效,并增加了后续维护代码所需的时间。本研究旨在探讨大型语言模型(LLMs)在此类情况下生成潜在更优注释的效用。本研究重点关注将设计文档作为上下文提供给LLMs以生成更有用注释的可行性,因为当注释不足时,维护人员通常使用设计文档来理解代码。