論文の概要: Linking Code and Documentation Churn: Preliminary Analysis

• arxiv url: http://arxiv.org/abs/2410.05992v1
• Date: Tue, 8 Oct 2024 12:41:58 GMT
• ステータス: 処理完了
• システム内更新日: 2024-11-01 11:50:19.099270
• Title: Linking Code and Documentation Churn: Preliminary Analysis
• Title（参考訳）: コードのリンクとドキュメントのチャーン:予備分析
• Authors: Ani Hovhannisyan, Youmei Fan, Gema Rodriguez-Perez, Raula Gaikovina Kula,
• Abstract要約: 本研究では,GitHubの3つのオープンソースプロジェクトにおけるコードチャーンとドキュメント更新の同期について検討する。 予備的な結果は、プロジェクト間で異なる同期度を示し、統合された並行ドキュメントプラクティスの重要性を強調します。 この研究の斬新さは、コードの変更とドキュメントの更新を同期させることが、多様性と効率を向上させることで、開発ライフサイクルをいかに改善できるかを示すことである。
• 参考スコア（独自算出の注目度）: 2.033674689332928
• License: http://creativecommons.org/licenses/by/4.0/
• Abstract: Code churn refers to the measure of the amount of code added, modified, or deleted in a project and is often used to assess codebase stability and maintainability. Program comprehension or how understandable the changes are, is equally important for maintainability. Documentation is crucial for knowledge transfer, especially when new maintainers take over abandoned code. We emphasize the need for corresponding documentation updates, as this reflects project health and trustworthiness as a third-party library. Therefore, we argue that every code change should prompt a documentation update (defined as documentation churn). Linking code churn changes with documentation updates is important for project sustainability, as it facilitates knowledge transfer and reduces the effort required for program comprehension. This study investigates the synchrony between code churn and documentation updates in three GitHub open-source projects. We will use qualitative analysis and repository mining to examine the alignment and correlation of code churn and documentation updates over time. We want to identify which code changes are likely synchronized with documentation and to what extent documentation can be auto-generated. Preliminary results indicate varying degrees of synchrony across projects, highlighting the importance of integrated concurrent documentation practices and providing insights into how recent technologies like AI, in the form of Large Language Models (i.e., LLMs), could be leveraged to keep code and documentation churn in sync. The novelty of this study lies in demonstrating how synchronizing code changes with documentation updates can improve the development lifecycle by enhancing diversity and efficiency.
• Abstract（参考訳）: コードチャーン(Code Churn)は、プロジェクトで追加、修正、削除されたコードの量を表し、コードベースの安定性と保守性を評価するためにしばしば使用される。 プログラムの理解や変更の理解は、保守性にも同じように重要です。 ドキュメンテーションは、特に新しいメンテナが放棄されたコードを引き継いだ場合、知識伝達に不可欠である。 これは、サードパーティのライブラリとしてのプロジェクトの健全性と信頼性を反映しています。 したがって、すべてのコード変更がドキュメント更新(ドキュメントのチャーンとして定義される)を促すべきだ、と私たちは主張する。 コードの変更とドキュメントの更新をリンクすることは、プロジェクトの持続可能性にとって重要である。 本研究では,GitHubの3つのオープンソースプロジェクトにおけるコードチャーンとドキュメント更新の同期について検討する。 定性的分析とリポジトリマイニングを使用して、コードチャーンとドキュメント更新のアライメントと相関を調べます。 どのコード変更がドキュメンテーションと同期しているか、どの程度でドキュメンテーションを自動生成できるかを特定したいのです。 予備的な結果は、プロジェクト間での同期の度合いの変化を示し、統合された並行ドキュメントプラクティスの重要性を強調し、AIのような最近の技術が、どのようにしてLLM(Large Language Models)の形で利用され、コードとドキュメントの同期が保たれるかについての洞察を提供する。 この研究の斬新さは、コードの変更とドキュメントの更新を同期させることが、多様性と効率を向上させることで、開発ライフサイクルをいかに改善できるかを示すことである。

関連論文リスト

• Supporting Software Maintenance with Dynamically Generated Document Hierarchies [41.407915858583344]
  HGENは、ソースコードを6つのステージで変換し、構造化された文書の階層構造に変換する、完全に自動化されたパイプラインである。 我々はHGENを定量的にも質的にも評価した。 その結果,HGENは手作業で構築したドキュメントに類似したアーティファクト階層を生成し,コアコンセプトをベースラインアプローチよりもはるかに高いカバレッジで実現していることがわかった。
  論文  参考訳（メタデータ） (2024-08-11T17:11:14Z)
• Code Documentation and Analysis to Secure Software Development [0.0]
  CoDATは、さまざまなレベルのコードドキュメント間の一貫性を維持するように設計されたツールである。 Intellij IDEAで実装されている。 私たちは、コードの断片とそれを記述するコメントの間のセマンティックな一貫性をチェックするために、大きな言語モデルを使用します。
  論文  参考訳（メタデータ） (2024-07-16T17:25:44Z)
• CodeUpdateArena: Benchmarking Knowledge Editing on API Updates [77.81663273436375]
  コードドメインの知識編集のためのベンチマークであるCodeUpdateArenaを提示する。 私たちのベンチマークのインスタンスは、プログラム合成例と組み合わせた合成API関数のアップデートで構成されています。 ベンチマークでは、7つのPythonパッケージから54の関数へ、さまざまなタイプの更新をカバーしています。
  論文  参考訳（メタデータ） (2024-07-08T17:55:04Z)
• CodeRAG-Bench: Can Retrieval Augment Code Generation? [78.37076502395699]
  検索拡張生成を用いたコード生成の系統的,大規模な解析を行う。 まず、コード生成タスクの3つのカテゴリを含む総合的な評価ベンチマークであるCodeRAG-Benchをキュレートする。 CodeRAG-Bench上のトップパフォーマンスモデルについて、1つまたは複数のソースから検索したコンテキストを提供することにより検討する。
  論文  参考訳（メタデータ） (2024-06-20T16:59:52Z)
• VersiCode: Towards Version-controllable Code Generation [58.82709231906735]
  大規模言語モデル(LLM)は、コード生成において大きな進歩を遂げていますが、既存の研究は、ソフトウェア開発の動的な性質を説明できません。 バージョン別コード補完(VSCC)とバージョン別コードマイグレーション(VACM)の2つの新しいタスクを提案する。 VersiCodeについて広範な評価を行い、バージョン管理可能なコード生成が確かに重要な課題であることを示した。
  論文  参考訳（メタデータ） (2024-06-11T16:15:06Z)
• A^3-CodGen: A Repository-Level Code Generation Framework for Code Reuse with Local-Aware, Global-Aware, and Third-Party-Library-Aware [13.27883339389175]
  本稿では,A3-CodGenと呼ばれる新しいコード生成フレームワークを提案する。 その結果、A3-CodGenフレームワークを採用することで、コードリポジトリ情報をLLMに抽出、ヒューズ、フィードし、より正確で、効率的で、再利用性の高いコードを生成します。
  論文  参考訳（メタデータ） (2023-12-10T05:36:06Z)
• CrossCodeEval: A Diverse and Multilingual Benchmark for Cross-File Code Completion [86.01508183157613]
  CrossCodeEvalは4つの人気のあるプログラミング言語の様々な現実世界、オープンソース、パーミッシブライセンスのリポジトリ上に構築されている。 関連するクロスファイルコンテキストが欠如している場合、CrossCodeEvalは極めて困難であることを示す。 また、コードレトリバーの能力を測定するためにCrossCodeEvalが使えることも示しています。
  論文  参考訳（メタデータ） (2023-10-17T13:18:01Z)
• Wait, wasn't that code here before? Detecting Outdated Software Documentation [9.45052138795667]
  古いコード要素参照を自動的にスキャンするGitHub Actionsツールを提示する。 GitHubで最も人気のある1000のプロジェクトの4分の1以上には、少なくとも1つの古い参照が含まれている。
  論文  参考訳（メタデータ） (2023-07-10T00:52:29Z)
• RepoCoder: Repository-Level Code Completion Through Iterative Retrieval and Generation [96.75695811963242]
  RepoCoderはリポジトリレベルのコード補完プロセスを合理化するフレームワークである。 類似性ベースのレトリバーと、事前訓練されたコード言語モデルが組み込まれている。 バニラ検索で拡張されたコード補完アプローチよりも一貫して優れています。
  論文  参考訳（メタデータ） (2023-03-22T13:54:46Z)
• ReACC: A Retrieval-Augmented Code Completion Framework [53.49707123661763]
  本稿では,語彙のコピーと類似したセマンティクスを持つコード参照の両方を検索により活用する検索拡張コード補完フレームワークを提案する。 我々は,Python および Java プログラミング言語のコード補完タスクにおけるアプローチを評価し,CodeXGLUE ベンチマークで最先端のパフォーマンスを実現する。
  論文  参考訳（メタデータ） (2022-03-15T08:25:08Z)

関連論文リストは本サイト内にある論文のタイトル・アブストラクトから自動的に作成しています。

指定された論文の情報です。
本サイトの運営者は本サイト（すべての情報・翻訳含む）の品質を保証せず、本サイト（すべての情報・翻訳含む）を使用して発生したあらゆる結果について一切の責任を負いません。