論文の概要: Understanding Code Understandability Improvements in Code Reviews
- arxiv url: http://arxiv.org/abs/2410.21990v2
- Date: Tue, 12 Nov 2024 14:17:32 GMT
- ステータス: 翻訳完了
- システム内更新日: 2024-11-13 13:18:10.452734
- Title: Understanding Code Understandability Improvements in Code Reviews
- Title（参考訳）: コードレビューにおけるコードの理解可能性向上の理解
- Authors: Delano Oliveira, Reydne Santos, Benedito de Oliveira, Martin Monperrus, Fernando Castor, Fernanda Madeiral,
- Abstract要約: GitHub上のJavaオープンソースプロジェクトからの2,401のコードレビューコメントを分析した。
改善提案の83.9%が承認され、統合され、1%未満が後に復活した。
- 参考スコア（独自算出の注目度）: 79.16476505761582
- License:
- Abstract: Motivation: Code understandability is crucial in software development, as developers spend 58% to 70% of their time reading source code. Improving it can improve productivity and reduce maintenance costs. Problem: Experimental studies often identify factors influencing code understandability in controlled settings but overlook real-world influences like project culture, guidelines, and developers' backgrounds. Ignoring these factors may yield results with limited external validity. Objective: This study investigates how developers enhance code understandability through code review comments, assuming that code reviewers are specialists in code quality. Method and Results: We analyzed 2,401 code review comments from Java open-source projects on GitHub, finding that over 42% focus on improving code understandability. We further examined 385 comments specifically related to this aspect and identified eight categories of concerns, such as inadequate documentation and poor identifiers. Notably, 83.9% of suggestions for improvement were accepted and integrated, with fewer than 1% later reverted. We identified various types of patches that enhance understandability, from simple changes like removing unused code to context-dependent improvements such as optimizing method calls. Additionally, we evaluated four well-known linters for their ability to flag these issues, finding they cover less than 30%, although many could be easily added as new rules. Implications: Our findings encourage the development of tools to enhance code understandability, as accepted changes can serve as reliable training data for specialized machine-learning models. Our dataset supports this training and can inform the development of evidence-based code style guides. Data Availability: Our data is publicly available at https://codeupcrc.github.io.
- Abstract（参考訳）: モチベーション(Motivation): 開発者がソースコードを読むのに58%から70%を費やすため、コードの理解性はソフトウェア開発において不可欠である。
改善は生産性を向上し、メンテナンスコストを削減します。
問題: 実験的研究は、制御された設定におけるコード理解性に影響を与える要因をしばしば特定するが、プロジェクト文化やガイドライン、開発者のバックグラウンドといった現実世界の影響を見落としている。
これらの因子を無視すると、外部の妥当性が制限された結果が得られる可能性がある。
Objective: コードレビューのコメントを通じて,コードレビュー担当者がコード品質の専門家であることを前提として,開発者がコードの理解性を高める方法について検討する。
方法と結果: GitHub上のJavaオープンソースプロジェクトからの2,401件のコードレビューのコメントを分析し、コード理解性の改善に42%以上が集中していることを発見した。
さらに、この側面に特化して385のコメントを検証し、不適切なドキュメンテーションや不十分な識別子など8つのカテゴリの関心事項を特定した。
特に、改善提案の83.9%が受け入れられ、統合され、1%未満が後に復活した。
未使用コードの削除やメソッド呼び出しの最適化といったコンテキスト依存の改善といった単純な変更から、可理解性を高めるパッチの種類を特定しました。
さらに、これらの問題にフラグを付ける能力で有名な4つのリンタを評価し、30%未満をカバーしているが、その多くは新しいルールとして簡単に追加できる。
私たちの発見は、コード理解可能性を高めるツールの開発を奨励します。
私たちのデータセットはこのトレーニングをサポートし、エビデンスベースのコードスタイルガイドの開発を知らせることができます。
データ可用性: 私たちのデータはhttps://codeupcrc.github.io.comで公開されています。
関連論文リスト
- RedCode: Risky Code Execution and Generation Benchmark for Code Agents [50.81206098588923]
RedCodeはリスクの高いコード実行と生成のためのベンチマークである。
RedCode-Execは、危険なコード実行につながる可能性のある、挑戦的なプロンプトを提供する。
RedCode-Genは160のプロンプトに関数シグネチャとドキュメントを入力として提供し、コードエージェントが命令に従うかどうかを評価する。
論文 参考訳（メタデータ） (2024-11-12T13:30:06Z) - Assessing Consensus of Developers' Views on Code Readability [3.798885293742468]
開発者はコードレビューに多くの時間を費やし、コード理解におけるコード可読性の重要性を強調している。
以前の調査では、既存のコード可読性モデルは開発者の考えを表現する上で不正確であった。
同じようなコーディング経験を持つ10人のJava開発者を調査して、コード可読性評価と関連する側面について、彼らのコンセンサスを評価しました。
論文 参考訳（メタデータ） (2024-07-04T09:54:42Z) - An Empirical Study on Code Review Activity Prediction and Its Impact in Practice [7.189276599254809]
本稿では,提案パッチのどのファイルにコメントが必要か,(2)修正,(3)ホットスポットかを予測することで,コードレビュアを支援することを目的とする。
3つのオープンソースと2つの産業データセットに関する実証的研究は、コード埋め込みとレビュープロセスの機能を組み合わせることで、最先端のアプローチよりも優れた結果をもたらすことを示しています。
論文 参考訳（メタデータ） (2024-04-16T16:20:02Z) - How Far Have We Gone in Binary Code Understanding Using Large Language Models [51.527805834378974]
バイナリコード理解におけるLarge Language Models(LLM)の有効性を評価するためのベンチマークを提案する。
評価の結果、既存のLLMはバイナリコードをある程度理解でき、それによってバイナリコード解析の効率が向上することが明らかとなった。
論文 参考訳（メタデータ） (2024-04-15T14:44:08Z) - Code Prompting Elicits Conditional Reasoning Abilities in Text+Code LLMs [65.2379940117181]
自然言語の問題をコードに変換する一連のプロンプトであるコードプロンプトを導入します。
コードプロンプトは複数のLLMに対して高速に向上することがわかった。
GPT 3.5を解析した結果,入力問題のコードフォーマッティングが性能向上に不可欠であることが判明した。
論文 参考訳（メタデータ） (2024-01-18T15:32:24Z) - Toward Effective Secure Code Reviews: An Empirical Study of Security-Related Coding Weaknesses [14.134803943492345]
我々は OpenSSL と PHP の2つの大規模オープンソースプロジェクトで実証的なケーススタディを行った。
135,560のコードレビューコメントに基づいて、40のコーディング弱点カテゴリのうち35に、レビュー担当者がセキュリティ上の懸念を提起していることが分かりました。
メモリエラーやリソース管理といった過去の脆弱性に関連するコーディングの弱点は、脆弱性よりも少ない頻度で議論された。
論文 参考訳（メタデータ） (2023-11-28T00:49:00Z) - How do Developers Improve Code Readability? An Empirical Study of Pull
Requests [0.0]
私たちは、109のGitHubリポジトリの下で284のMerged Pull Requests(PR)から370のコード可読性の改善を集めています。
26種類のコード可読性を改善したカタログを作成しました。
驚いたことに、SonarQubeは370のコード可読性の改善のうち26だけを検出した。
論文 参考訳（メタデータ） (2023-09-05T21:31:21Z) - CONCORD: Clone-aware Contrastive Learning for Source Code [64.51161487524436]
セルフ教師付き事前トレーニングは、多くのダウンストリームSEタスクに価値のあるジェネリックコード表現を学ぶための牽引役になった。
汎用的な表現学習のために、開発者が日々どのようにコードをコーディングするかは、要因としても不可欠である、と私たちは主張する。
特に,表現空間に良性クローンを近づける自己教師型コントラスト学習戦略であるCONCORDを提案する。
論文 参考訳（メタデータ） (2023-06-05T20:39:08Z) - The Mind Is a Powerful Place: How Showing Code Comprehensibility Metrics
Influences Code Understanding [10.644832702859484]
ソースコードの理解度を示す指標が,ソースコードの理解度を主観的に評価する上で,開発者を悩ませるかどうかを検討する。
その結果、理解度測定値の表示値は、開発者のコード理解度評価に大きく、かつ大きなアンカー効果があることがわかった。
論文 参考訳（メタデータ） (2020-12-16T14:27:45Z) - Deep Just-In-Time Inconsistency Detection Between Comments and Source
Code [51.00904399653609]
本稿では,コード本体の変更によりコメントが矛盾するかどうかを検出することを目的とする。
私たちは、コメントとコードの変更を関連付けるディープラーニングアプローチを開発しています。
より包括的な自動コメント更新システムを構築するために,コメント更新モデルと組み合わせて提案手法の有用性を示す。
論文 参考訳（メタデータ） (2020-10-04T16:49:28Z)
関連論文リストは本サイト内にある論文のタイトル・アブストラクトから自動的に作成しています。
指定された論文の情報です。
本サイトの運営者は本サイト（すべての情報・翻訳含む）の品質を保証せず、本サイト（すべての情報・翻訳含む）を使用して発生したあらゆる結果について一切の責任を負いません。